Struct CommandId

#[repr(C)]
pub struct CommandId(/* private fields */);

An ID constructed as a cryptographic hash of a serialized Command.

Implementations

impl CommandId

pub const fn default() -> Self

Same as Default, but const.

pub fn random<R: Csprng>(rng: &mut R) -> Self

Creates a random ID.

pub const fn as_bytes(&self) -> &[u8]

Returns itself as a byte slice.

pub const fn as_array(&self) -> &[u8; 64]

Returns itself as a byte array.

pub const fn into_id(self) -> Id

Returns itself as a plain Id.

pub fn decode<T: AsRef<[u8]>>(s: T) -> Result<Self, DecodeError>

Decode the ID from a base58 string.

impl CommandId

pub fn hash_for_testing_only(data: &[u8]) -> Self

Derives a CommandId from some data.

This is for testing only. It’s not #[cfg(test)] because (unfortunately) some code already depends on it.

pub fn short_b58(&self) -> String

Trait Implementations

impl AsRef<[u8]> for CommandId

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CommandId

fn clone(&self) -> CommandId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for CommandId

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for CommandId

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

Formats the value using the given formatter.

impl Default for CommandId

fn default() -> CommandId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommandId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CommandId

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

Formats the value using the given formatter.

impl From<[u8; 64]> for CommandId

fn from(id: [u8; 64]) -> Self

Converts to this type from the input type.

impl From<CommandId> for [u8; 64]

fn from(id: CommandId) -> Self

Converts to this type from the input type.

impl From<CommandId> for Id

fn from(id: CommandId) -> Self

Converts to this type from the input type.

impl From<GenericArray<u8, UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for CommandId

fn from(id: GenericArray<u8, U64>) -> Self

Converts to this type from the input type.

impl From<Id> for CommandId

fn from(id: Id) -> Self

Converts to this type from the input type.

impl FromStr for CommandId

type Err = DecodeError

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 Hash for CommandId

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 MaxSize for CommandId

const POSTCARD_MAX_SIZE: usize = 64usize

The maximum possible size that the serialization of this type can have, in bytes.

impl Ord for CommandId

fn cmp(&self, other: &CommandId) -> 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 PartialEq for CommandId

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

fn partial_cmp(&self, other: &CommandId) -> 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 Serialize for CommandId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToBase58 for CommandId

type Output = String64

A Base58 string.

fn to_base58(&self) -> Self::Output

Encodes itself as a Base58 string.

impl Copy for CommandId

impl Eq for CommandId

impl StructuralPartialEq for CommandId