Struct Memory 

pub struct Memory { /* private fields */ }

What is remembered about each node. The ones not listed have nothing said about them, which is the same as nothing being kept.

Implementations

impl Memory

pub fn new() -> Self

Nothing remembered about anything.

pub fn identify( &mut self, id: impl Into<NodeId>, what: impl Into<String>, ) -> Option<String>

Says what implements this node, returning what it was called before.

pub fn identity_of(&self, id: &NodeId) -> Option<&str>

What implements it, if it was said.

pub fn declared_as( &mut self, id: impl Into<NodeId>, declaration: impl Into<String>, )

Says what this node was built with, as a digest of the arguments that made it. The class is half of what a node is; this is the other half.

pub fn declaration_of(&self, id: &NodeId) -> Option<&str>

What it was built with, if anybody could say. Absent is not a reason to refuse a key; refusing is cacheable’s side of it.

pub fn freeze(&mut self, id: impl Into<NodeId>, state: Option<String>)

Says this node’s state does not change from here on, with the digest of the state it is settled at. Called twice on purpose: .frozen() says it with no digest, and whoever can hash the weights says it again with one.

pub fn is_frozen(&self, id: &NodeId) -> bool

Whether this node’s state was said not to change.

pub fn state_of(&self, id: &NodeId) -> Option<&str>

The digest of the state it is frozen at, if it is frozen and has one.

pub fn cache(&mut self, id: impl Into<NodeId>, salt: Option<String>)

Says this node’s output is worth keeping, with the caller’s salt if they gave one — how you tell apart two runs the key cannot.

pub fn is_cached(&self, id: &NodeId) -> bool

Whether this node’s output is kept. Not being kept is no break in the chain: its key is still computed and passed on.

pub fn salt_of(&self, id: &NodeId) -> Option<&str>

The salt it is cached under, if it is cached and has one.

pub fn map(&mut self, id: impl Into<NodeId>)

Says this node maps over the items of its input: a list in, a list as long out, item i out from item i in.

What makes a cache work item by item — one new document among a thousand runs once instead of missing all thousand. Declared and not asked.

pub fn is_mapped(&self, id: &NodeId) -> bool

Whether this node was said to map over its items.

pub fn written_as( &mut self, id: impl Into<NodeId>, fingerprint: impl Into<String>, ) -> Option<String>

Notes which version of the code this graph was written against. Metadata: never in a key, only compared on a hit.

pub fn fingerprint_of(&self, id: &NodeId) -> Option<&str>

Which version of the code it was written against, if it was noted.

pub fn len(&self) -> usize

How many nodes have anything said about them at all.

pub fn is_empty(&self) -> bool

Whether nothing has been said about any node, which is what lets the engine skip all of this.

Trait Implementations

impl Clone for Memory

fn clone(&self) -> Memory

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Memory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Memory

fn default() -> Memory

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Memory

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Memory

fn eq(&self, other: &Memory) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Memory

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Memory

impl StructuralPartialEq for Memory