Struct rf_core::export::Export

pub struct Export { /* private fields */ }

Abstraction for the result of local computation. It is an AST decorated with the computation value.

Implementations

impl Export

pub fn new() -> Self

Create new Export.

Returns

The new Export.

pub fn put<A: 'static>(&mut self, path: Path, value: A)

Inserts a value in the Export at the given Path.

Arguments

• path - The Path where to insert the value.
• value - The value to insert.

Generic Parameters

• A - The type of the value to insert. It must have a 'static lifetime.

pub fn put_lazy<A: 'static, F>(&mut self, path: Path, fun: F)

where F: FnOnce() -> A,

Inserts a value in the Export at the given Path. The value is calculated from the provided function.

Arguments

• path - The Path where to insert the value.
• fun - The function from which we calculate the value to insert.

Generic Parameters

• A - The type of the value to insert. It must have a 'static lifetime.
• F - The type of the function from which the value is calculated.

pub fn put_lazy_and_return<A: 'static + Clone, F>( &mut self, path: Path, fun: F ) -> A

where F: FnOnce() -> A,

Inserts a value in the Export at the given Path. The value is calculated from the provided function and then returned to the caller.

Arguments

• path - The Path where to insert the value.
• fun - The function from which we calculate the value to insert.

Generic Parameters

• A - The type of the value to insert. It must have a 'static lifetime.
• F - The type of the function from which the value is calculated.

Returns

The calculated value.

pub fn get<A: 'static + FromStr + Clone>(&self, path: &Path) -> Result<A>

Returns the value at the given Path.

Arguments

• path - The Path where to get the value.

Generic Parameters

• A - The type of the value to get to return. It must have a 'static lifetime.

Returns

The value at the given Path.

pub fn root<A: 'static + FromStr + Clone>(&self) -> A

Obtain the root value. This function may panic, so it is preferable to use the non-panicking counterpart Export::root_as_result

Generic Parameters

• A - The type of the value to return. It must have a 'static lifetime.

Returns

The root value.

Panics

• Panics if there is not a root value (a value at the empty Path).
• Panics if the type of the root value is not the same as the type of the requested value.

pub fn root_as_result<A: 'static + FromStr + Clone>(&self) -> Result<A>

Obtain the root value. This method is the non-panicking version of Export::root

Generic Parameters

• A - The type of the value to return. It must have a 'static lifetime.

Returns

A Result containing the root value if present and an error otherwise.

pub fn paths(&self) -> &HashMap<Path, Rc<Box<dyn Any>>>

Returns the HashMap of the Export.

Returns

The HashMap of the Export.

Trait Implementations

impl Clone for Export

fn clone(&self) -> Export

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Export

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

Formats the value using the given formatter.

impl Default for Export

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Export

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Export

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

Formats the value using the given formatter.

impl From<HashMap<Path, Rc<Box<dyn Any>>>> for Export

fn from(map: HashMap<Path, Rc<Box<dyn Any>>>) -> Self

Converts to this type from the input type.

impl PartialEq for Export

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Export

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

where __S: Serializer,

Serialize this value into the given Serde serializer.