Struct raystack::Symbol

pub struct Symbol(_);

A Haystack Symbol.

Implementations

impl Symbol

pub fn new(s: String) -> Result<Symbol, ParseSymbolError>

Create a new Symbol.

Example

use raystack_core::Symbol;
let my_symbol = Symbol::new("^steam-boiler".to_string()).unwrap();

pub fn from_encoded_json_string(
    json_string: &str
) -> Result<Symbol, ParseSymbolError>

Return a Symbol by decoding a symbol which was encoded in a JSON string. In raw JSON strings, symbols are formatted with a y: prefix instead of an ^ character.

Example

use raystack_core::Symbol;
let json_str = "y:steam-boiler"; // ^steam-boiler
let my_symbol = Symbol::from_encoded_json_string(json_str).unwrap();

pub fn to_encoded_json_string(&self) -> String

Return a string containing this symbol, encoded with a y: prefix instead of with an ^ character. This representation for symbols is used in raw JSON strings sent to and from a Haystack server.

pub fn into_string(self) -> String

Convert this symbol into a string.

pub fn to_axon_code(&self) -> &str

Return this symbol as an Axon symbol literal.

Trait Implementations

impl AsRef<str> for Symbol

pub fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Symbol

pub fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Display for Symbol

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

Formats the value using the given formatter.

impl FromStr for Symbol

type Err = ParseSymbolError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Symbol, <Symbol as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hayson for Symbol

pub fn from_hayson(value: &Value) -> Result<Symbol, FromHaysonError>

pub fn to_hayson(&self) -> Value

impl PartialEq<Symbol> for Symbol

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

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

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

This method tests for !=.

impl Eq for Symbol

impl StructuralEq for Symbol

impl StructuralPartialEq for Symbol