Struct LedgerId 

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

A ledger’s identity: 1–255 bytes, each printable ASCII (0x21–0x7E) except +.

Usable verbatim as a C2SP checkpoint origin and note key name, by convention a domain-style name such as example.com/acme.

use doubleentry::LedgerId;

assert!(LedgerId::new("example.com/acme").is_ok());
assert!(LedgerId::new("has space").is_err());

Implementations

impl LedgerId

pub const MAX_BYTES: usize = 255

The most bytes in a ledger id.

pub fn new(text: impl Into<String>) -> Result<Self, ValueError>

Validates a ledger id.

Errors

ValueError::Empty, ValueError::TooLong above 255 bytes, or ValueError::InvalidCharacter for a space, +, a control or a non-ASCII character.

pub fn as_str(&self) -> &str

The id as text.

Trait Implementations

impl AsRef<str> for LedgerId

fn as_ref(&self) -> &str

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

impl Clone for LedgerId

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 LedgerId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LedgerId

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for LedgerId

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

Formats the value using the given formatter.

impl Eq for LedgerId

impl From<&LedgerId> for KeyName

fn from(ledger: &LedgerId) -> Self

Converts to this type from the input type.

impl FromStr for LedgerId

type Err = ValueError

The associated error which can be returned from parsing.

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

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

impl Hash for LedgerId

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 LedgerId

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 LedgerId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for LedgerId

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 Serialize for LedgerId

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LedgerId

impl TryFrom<&str> for LedgerId

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(text: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for LedgerId

type Error = ValueError

The type returned in the event of a conversion error.

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

Performs the conversion.