Struct FieldIdentifier 

pub struct FieldIdentifier {
    pub name: StorageValueName,
    pub description: Option<String>,
}

An identifier for a storage entry field.

An identifier consists of a name that identifies the field, and an optional description.

Fields

name: StorageValueName

A human-readable identifier for the template.

description: Option<String>

An optional description explaining the purpose of this template.

Implementations

impl FieldIdentifier

pub fn with_name(name: StorageValueName) -> Self

Creates a new FieldIdentifier with the given name and no description.

pub fn with_description( name: StorageValueName, description: impl Into<String>, ) -> Self

Creates a new FieldIdentifier with the given name and description.

pub fn name(&self) -> &StorageValueName

Returns the identifier name.

pub fn description(&self) -> Option<&String>

Returns the identifier description.

Trait Implementations

impl Clone for FieldIdentifier

fn clone(&self) -> FieldIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldIdentifier

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

Formats the value using the given formatter.

impl Deserializable for FieldIdentifier

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl<'de> Deserialize<'de> for FieldIdentifier

fn deserialize<D>(deserializer: D) -> Result<FieldIdentifier, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StorageValueName> for FieldIdentifier

fn from(value: StorageValueName) -> Self

Converts to this type from the input type.

impl PartialEq for FieldIdentifier

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

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

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

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Serialize for FieldIdentifier

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 FieldIdentifier

impl StructuralPartialEq for FieldIdentifier