Enum Who 

pub enum Who {
    City,
    Person,
    Resident(Address),
}

The three parties a ledger line can be attributed to.

Every line of every history carries one of these, and until this type existed each writer spelled its own: six call sites wrote the literal "city" and a resident wrote its address, so a seventh spelling was one keystroke away and nothing would have refused it.

The wire form is what the histories already hold. The city is city, a person is person, and a resident is its address, exactly as before; no ledger on disk has to be re-spelled for this type to read it.

Variants

City

The city’s desk: genesis, dispatch, truncation, relaying.

Person

A person, through a client.

Resident(Address)

A resident of a building, at the address it is known by.

Implementations

impl Who

pub fn resident(addr: Address) -> Result<Who, AxError>

A resident’s attribution.

Errors

E_INVALID_ARGS for an address spelled city or person: those two words are the other two parties on this wire, and a resident answering to one of them would make a line’s author unreadable.

pub fn as_str(&self) -> &str

The word a ledger line carries.

pub fn parse(raw: &str) -> Result<Who, AxError>

Reads back what Who::as_str wrote.

Errors

E_INVALID_ARGS for a word that is neither reserved nor a canonical address.

Trait Implementations

impl Clone for Who

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 Who

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Who

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

Deserialize this value from the given Serde deserializer.

impl Display for Who

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

Formats the value using the given formatter.

impl Eq for Who

impl Hash for Who

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 Who

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 Who

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Who

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 Who

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Who