Struct Subject 

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

A subject of EventSourcingDB, which is a path such as /books/42: it starts with a slash, / alone is the root, and its segments are separated by single slashes, none of them empty, each made only of the characters A-Z, a-z, 0-9, underscores, and hyphens. A single slash at the end is taken, and left out, as the database does, so /books/42/ is /books/42. A value that is no such path can not be a subject at all.

A subject that is written in the code is made with new, which panics for one that is not a subject. One that comes from outside, such as a path in a request, is read with parse, which refuses it with NotASubject, and one that is made of values from outside is built with SubjectScheme::try_build:

use architecturekit::Subject;

let book = Subject::new("/books/42");
assert_eq!(book.as_str(), "/books/42");

let read: Subject = "/books/42/".parse()?;
assert_eq!(read, book);

assert!("books/42".parse::<Subject>().is_err());

serde writes and reads a subject as a string.

Implementations

impl Subject

pub fn new(subject: &str) -> Self

Takes a subject that is written in the code.

Panics

A subject that is not one is a programming error, so this panics. For a subject that comes from outside, use parse instead.

pub fn root() -> Self

Returns the root, /, which every subject lies under.

pub fn as_str(&self) -> &str

Returns the subject as text.

Trait Implementations

impl AsRef<str> for Subject

fn as_ref(&self) -> &str

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

impl Borrow<str> for Subject

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Subject

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 Subject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Subject

Reads the subject from a string, as parse does, and fails with the text of NotASubject for a string that is not one.

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

Deserialize this value from the given Serde deserializer.

impl Display for Subject

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

Formats the value using the given formatter.

impl Eq for Subject

impl From<Subject> for String

fn from(subject: Subject) -> Self

Converts to this type from the input type.

impl FromStr for Subject

Reads a subject, and leaves out a single slash at its end.

Errors

Fails with NotASubject for a value that does not start with a slash, that has an empty segment, or a segment with a character the database does not allow in a subject.

type Err = NotASubject

The associated error which can be returned from parsing.

fn from_str(subject: &str) -> Result<Self, NotASubject>

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

impl Hash for Subject

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 Subject

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 Subject

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Subject

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 Subject

Writes the subject as a string.

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Subject