Struct raystack_core::Ref

pub struct Ref(_);

A Haystack Ref.

Implementations

impl Ref

pub fn new(s: String) -> Result<Self, ParseRefError>

Create a new Ref.

Example

use raystack_core::Ref;
let my_ref = Ref::new("@p:bigProject:r:24efe1c4-24aef280".to_string()).unwrap();

pub fn from_encoded_json_string(
    json_string: &str
) -> Result<Self, ParseRefError>

Return a Ref by decoding a ref which was encoded in a JSON string. In raw JSON strings, refs are formatted with a r: prefix instead of an @ sign.

Example

use raystack_core::Ref;
let json_str = "r:p:bigProject:r:24efe1c4-24aef280";
let my_ref = Ref::from_encoded_json_string(json_str).unwrap();

pub fn to_encoded_json_string(&self) -> String

Return a string containing this ref, encoded with a r: prefix instead of with an @ sign. This representation for refs is used in raw JSON strings sent to and from a Haystack server.

pub fn into_string(self) -> String

Convert this ref into a string.

pub fn to_axon_code(&self) -> &str

Return this ref as an Axon ref literal.

Trait Implementations

impl AsRef<str> for Ref

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Ref

fn clone(&self) -> Ref

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ref

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

Formats the value using the given formatter.

impl Display for Ref

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

Formats the value using the given formatter.

impl FromStr for Ref

type Err = ParseRefError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl PartialEq<Ref> for Ref

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

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

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

This method tests for !=.

impl Eq for Ref

impl StructuralEq for Ref

impl StructuralPartialEq for Ref