Struct Entry 

pub struct Entry(/* private fields */);

A canonical absolute path to an entry in the current Worldspace.

This replaces the pre-canonical Entry<K, V> key/value pair. Construct an entry from a path such as /articles/1; application data associated with that entry belongs in an ordinary record alongside this value.

Implementations

impl Entry

pub fn new(path: impl Into<String>) -> Result<Self, CodecError>

Validates and creates an entry path.

pub fn as_str(&self) -> &str

Returns the canonical absolute Worldspace path.

pub fn into_string(self) -> String

Consumes the entry and returns its path.

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entry

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

Formats the value using the given formatter.

impl Eq for Entry

impl FromStr for Entry

type Err = CodecError

The associated error which can be returned from parsing.

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

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

impl Hash for Entry

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Entry

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Entry

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Entry

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Entry

impl TryFrom<String> for Entry

type Error = CodecError

The type returned in the event of a conversion error.

fn try_from(path: String) -> Result<Self, Self::Error>

Performs the conversion.

impl WipType for Entry

fn type_expr() -> TypeExpr

Returns the protocol type expression for this Rust type.

fn collect_declarations(_: &mut Vec<TypeDeclaration>)

Adds named declarations reachable from this type to declarations.

fn encode(self) -> Result<Value, CodecError>

Encodes this value into the transport-independent protocol value model.

fn decode(value: Value) -> Result<Self, CodecError>

Decodes a previously validated protocol value.