Struct Algorithm 

pub struct Algorithm {
    pub id: Option<String>,
    pub name: Option<String>,
    pub number: Option<String>,
    pub caption: Option<String>,
    pub inputs: Vec<AlgorithmParam>,
    pub outputs: Vec<AlgorithmParam>,
    pub body: Vec<AlgorithmLine>,
    pub line_numbers: bool,
    pub start_line: Option<u32>,
}

A pseudocode algorithm block.

Fields

id: Option<String>

Optional unique identifier.

name: Option<String>

Algorithm name/title.

number: Option<String>

Algorithm number.

caption: Option<String>

Caption/description.

inputs: Vec<AlgorithmParam>

Input parameters.

outputs: Vec<AlgorithmParam>

Output parameters.

body: Vec<AlgorithmLine>

Algorithm body (pseudocode lines).

line_numbers: bool

Whether to show line numbers.

start_line: Option<u32>

Starting line number (default: 1).

Implementations

impl Algorithm

pub fn new(body: Vec<AlgorithmLine>) -> Self

Create a new algorithm.

pub fn with_name(self, name: impl Into<String>) -> Self

Set the name.

pub fn with_input( self, name: impl Into<String>, description: impl Into<String>, ) -> Self

Add an input parameter.

pub fn with_output( self, name: impl Into<String>, description: impl Into<String>, ) -> Self

Add an output parameter.

Trait Implementations

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Algorithm

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Algorithm

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

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 Algorithm

impl StructuralPartialEq for Algorithm