Struct surrealml_core::storage::header::output::Output

pub struct Output {
    pub name: Option<String>,
    pub normaliser: Option<NormaliserType>,
}

Houses data around the outputs of the model.

Fields

• name - The name of the output.
• normaliser - The normaliser to be applied to the output if there is one.

Fields

name: Option<String>

normaliser: Option<NormaliserType>

Implementations

impl Output

pub fn fresh() -> Self

Creates a new instance of the Output struct with no normaliser or name.

Returns

A new instance of the Output struct with no normaliser or name.

pub fn new(name: String) -> Self

Creates a new instance of the Output struct without a normaliser.

Arguments

• name - The name of the output.

pub fn add_normaliser(&mut self, normaliser: NormaliserType)

Adds a normaliser to the output.

Arguments

• normaliser - The normaliser to be applied to the output.

pub fn to_string(&self) -> String

Converts the output struct to a string.

Returns

• String - The output struct as a string.

pub fn from_string(data: String) -> Result<Self, SurrealError>

Converts a string to an instance of the Output struct.

Arguments

• data - The string to be converted into an instance of the Output struct.

Returns

• Output - The string as an instance of the Output struct.

Trait Implementations

impl Debug for Output

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

Formats the value using the given formatter.

impl PartialEq for Output

fn eq(&self, other: &Output) -> 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 StructuralPartialEq for Output