Skip to main content

By

Enum By 

Source
pub enum By {
    Person(String),
    Session(Who),
    SignIn(String),
    Server,
    Other,
}
Expand description

Who caused a record: the caller of its command, with its class (01M3X4Z60G1FXQTDC5XDJ05BAX). It holds only the user and the session ID. The session in a change is a full URI, with the place.

CallerJSON
a person{"person":"mike"}
a session{"session":"mike/a6cf"}
a sign-in{"sign_in":"mike@comotechnologies.io"}
the server"server"

The set of classes can grow. A build reads a class that it does not know as By::Other.

use riff_core::name::Who;
use riff_core::record::By;

let session = By::Session(Who::new("mike", Some("a6cf"))?);
assert_eq!(serde_json::to_string(&session).unwrap(), r#"{"session":"mike/a6cf"}"#);
assert_eq!(serde_json::to_string(&By::Server).unwrap(), r#""server""#);
assert_eq!(session.to_string(), "the session mike/a6cf");

let read = |json: &str| serde_json::from_str::<By>(json).unwrap();
assert_eq!(read(r#"{"person":"mike"}"#), By::Person("mike".into()));
assert_eq!(read(r#"{"session":"mike/a6cf"}"#), session);
assert_eq!(read(r#""server""#), By::Server);
// A class of a later build.
assert_eq!(read(r#"{"robot":"r2"}"#), By::Other);
assert_eq!(read(r#""cron""#), By::Other);

Variants§

§

Person(String)

A person, by the user.

§

Session(Who)

An agent session, by the user and the session ID.

§

SignIn(String)

A verified email of the provider, before a token is there.

§

Server

A timer of riff-server.

§

Other

A class that this build does not know.

Implementations§

Source§

impl By

Source

pub fn json(&self) -> Value

The class and the name as a JSON value: the form in a record and in a log line.

Trait Implementations§

Source§

impl Clone for By

Source§

fn clone(&self) -> By

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for By

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for By

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for By

The caller for people, for example the session mike/a6cf.

Source§

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

Formats the value using the given formatter. Read more
Source§

impl JsonSchema for By

The schema takes each value: By reads a class that it does not know as By::Other.

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn json_schema(_: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

impl PartialEq for By

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for By

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for By

Source§

impl StructuralPartialEq for By

Auto Trait Implementations§

§

impl Freeze for By

§

impl RefUnwindSafe for By

§

impl Send for By

§

impl Sync for By

§

impl Unpin for By

§

impl UnsafeUnpin for By

§

impl UnwindSafe for By

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,