Struct Path

pub struct Path<T: Form = MetaForm> {
    pub segments: Vec<T::String>,
}

Represents the path of a type definition.

This consists of several segments that each have to be a valid Rust identifier. The first segment represents the crate name in which the type has been defined. The last segment is the identifier accessed with ident().

Rust prelude type may have an empty namespace definition.

Fields

segments: Vec<T::String>

The segments of the namespace.

Implementations

impl Path<MetaForm>

pub fn new(ident: &'static str, module_path: &'static str) -> Path

Create a new Path

Panics

• If the type identifier or module path contain invalid Rust identifiers

pub fn new_with_replace( ident: &'static str, module_path: &'static str, segment_replace: &[(&'static str, &'static str)], ) -> Path

Create a new Path

The segment_replace is a list of (search, replace) items. Every search item that appears in the module_path is replaced by the replace item. This can be used for example to replace the crate name or even the name of the type in the final Path.

Panics

• If the type identifier, module path or replace contain invalid Rust identifiers

pub fn from_segments<I>(segments: I) -> Result<Self, PathError>

where I: IntoIterator<Item = <MetaForm as Form>::String>,

Create a Path from the given segments

Errors

• If no segments are supplied
• If any of the segments are invalid Rust identifiers

impl<T> Path<T>

where T: Form,

pub fn from_segments_unchecked<I>(segments: I) -> Path<T>

where I: IntoIterator<Item = T::String>,

Create a Path from the given segments.

Does not check that the segments are valid Rust identifiers.

pub fn segments(&self) -> &[T::String]

👎Deprecated since 2.5.0: Prefer to access the fields directly; this getter will be removed in the next major version

Returns the segments of the Path

pub fn is_empty(&self) -> bool

Returns true if the path is empty

pub fn ident(&self) -> Option<T::String>

Get the ident segment of the Path

pub fn namespace(&self) -> &[T::String]

Get the namespace segments of the Path

Trait Implementations

impl<T: Clone + Form> Clone for Path<T>

where T::String: Clone,

fn clone(&self) -> Path<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Form> Debug for Path<T>

where T::String: Debug,

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

Formats the value using the given formatter.

impl<T: Form> Decode for Path<T>

where Vec<T::String>: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T> Default for Path<T>

where T: Form,

fn default() -> Self

Returns the “default value” for a type.

impl Display for Path<PortableForm>

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

Formats the value using the given formatter.

impl<T: Form> Encode for Path<T>

where Vec<T::String>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<__CodecOutputReturn, __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl IntoPortable for Path

type Output = Path<PortableForm>

The portable version of Self.

fn into_portable(self, _registry: &mut Registry) -> Self::Output

Convert self to the portable form by using the registry for caching.

impl<T: Ord + Form> Ord for Path<T>

where T::String: Ord,

fn cmp(&self, other: &Path<T>) -> 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.

impl<T: PartialEq + Form> PartialEq for Path<T>

where T::String: PartialEq,

fn eq(&self, other: &Path<T>) -> 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<T: PartialOrd + Form> PartialOrd for Path<T>

where T::String: PartialOrd,

fn partial_cmp(&self, other: &Path<T>) -> 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<T: Form> EncodeLike for Path<T>

where Vec<T::String>: Encode,

impl<T: Eq + Form> Eq for Path<T>

where T::String: Eq,

impl<T: Form> StructuralPartialEq for Path<T>