Struct Identifier

pub struct Identifier<N>(/* private fields */)
where
    N: Network;

An identifier is an immutable UTF-8 string, represented as a constant field element in the CurrentNetwork.

Requirements

The identifier must not be an empty string. The identifier must not start with a number. The identifier must be alphanumeric, and may include underscores. The identifier must not consist solely of underscores. The identifier must fit within the data capacity of a base field element.

Implementations

impl<N> Identifier<N>

where N: Network,

pub fn size_in_bits(&self) -> u8

Returns the number of bits of this identifier.

Trait Implementations

impl<N> Clone for Identifier<N>

where N: Clone + Network,

fn clone(&self) -> Identifier<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Identifier<N>

where N: Network,

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

Formats the value using the given formatter.

impl<'de, N> Deserialize<'de> for Identifier<N>

where N: Network,

fn deserialize<D>( deserializer: D, ) -> Result<Identifier<N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes the identifier from a string or bytes.

impl<N> Display for Identifier<N>

where N: Network,

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

Prints the identifier as a string.

impl<N> Equal for Identifier<N>

where N: Network,

fn is_equal(&self, other: &Identifier<N>) -> <Identifier<N> as Equal>::Output

Returns true if self and other are equal.

fn is_not_equal( &self, other: &Identifier<N>, ) -> <Identifier<N> as Equal>::Output

Returns true if self and other are not equal.

type Output = Boolean<N>

impl<N> From<&Identifier<N>> for Identifier<N>

where N: Network,

fn from(identifier: &Identifier<N>) -> Identifier<N>

Returns a copy of the identifier.

impl<N> From<Identifier<N>> for PlaintextType<N>

where N: Network,

fn from(struct_: Identifier<N>) -> PlaintextType<N>

Initializes a plaintext type from a struct type.

impl<N> FromBits for Identifier<N>

where N: Network,

fn from_bits_le(bits_le: &[bool]) -> Result<Identifier<N>, Error>

Initializes a new identifier from a list of little-endian bits without trailing zeros.

fn from_bits_be(bits_be: &[bool]) -> Result<Identifier<N>, Error>

Initializes a new identifier from a list of big-endian bits without leading zeros.

impl<N> FromBytes for Identifier<N>

where N: Network,

fn read_le<R>(reader: R) -> Result<Identifier<N>, Error>

where R: Read,

Reads in an identifier from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N> FromField for Identifier<N>

where N: Network,

fn from_field( field: &<Identifier<N> as FromField>::Field, ) -> Result<Identifier<N>, Error>

Initializes a new identifier from a field element.

type Field = Field<N>

impl<N> FromStr for Identifier<N>

where N: Network,

fn from_str( identifier: &str, ) -> Result<Identifier<N>, <Identifier<N> as FromStr>::Err>

Reads in an identifier from a string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> Hash for Identifier<N>

where N: Network,

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

where H: Hasher,

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<N> Parser for Identifier<N>

where N: Network,

fn parse(string: &str) -> Result<(&str, Identifier<N>), Err<VerboseError<&str>>>

Parses a string into an identifier.

Requirements

The identifier must be alphanumeric (or underscore). The identifier must not start with a number. The identifier must not be a keyword.

impl<N> PartialEq for Identifier<N>

where N: Network,

fn eq(&self, other: &Identifier<N>) -> bool

Returns true if self and other are equal.

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<N> Serialize for Identifier<N>

where N: Network,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serializes the identifier into string or bytes.

impl<N> ToBits for &Identifier<N>

where N: Network,

fn write_bits_le(&self, vec: &mut Vec<bool>)

Returns the little-endian bits of the identifier.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Returns the big-endian bits of the identifier.

fn to_bits_le(&self) -> Vec<bool>

Returns self as a boolean array in little-endian order.

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<N> ToBits for Identifier<N>

where N: Network,

fn write_bits_le(&self, vec: &mut Vec<bool>)

Returns the little-endian bits of the identifier.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Returns the big-endian bits of the identifier.

fn to_bits_le(&self) -> Vec<bool>

Returns self as a boolean array in little-endian order.

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<N> ToBytes for Identifier<N>

where N: Network,

fn write_le<W>(&self, writer: W) -> Result<(), Error>

where W: Write,

Writes an identifier to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N> ToField for &Identifier<N>

where N: Network,

fn to_field(&self) -> Result<<&Identifier<N> as ToField>::Field, Error>

Returns the identifier as a field element.

type Field = Field<N>

impl<N> ToField for Identifier<N>

where N: Network,

fn to_field(&self) -> Result<<Identifier<N> as ToField>::Field, Error>

Returns the identifier as a field element.

type Field = Field<N>

impl<N> TryFrom<&String> for Identifier<N>

where N: Network,

fn try_from(identifier: &String) -> Result<Identifier<N>, Error>

Initializes an identifier from a string.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<&str> for Identifier<N>

where N: Network,

fn try_from(identifier: &str) -> Result<Identifier<N>, Error>

Initializes an identifier from a string.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<String> for Identifier<N>

where N: Network,

fn try_from(identifier: String) -> Result<Identifier<N>, Error>

Initializes an identifier from a string.

type Error = Error

The type returned in the event of a conversion error.

impl<N> Copy for Identifier<N>

where N: Copy + Network,

impl<N> Eq for Identifier<N>

where N: Network,