Struct ThreadName 

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

The name of a thread.

Implementations

impl ThreadName

pub fn chat() -> Self

The chat thread of riff chat.

assert_eq!(riff_core::name::ThreadName::chat().to_string(), "chat");

pub fn direct(a: &Who, b: &Who) -> Self

The thread that holds the direct messages between two sessions. The order of the two sessions does not matter.

use riff_core::name::{ThreadName, Who};

let a = Who::new("mike", Some("a6cf"))?;
let b = Who::new("brett", Some("77e0"))?;
assert_eq!(ThreadName::direct(&a, &b), ThreadName::direct(&b, &a));

pub fn is_direct(&self) -> bool

True for a thread of direct messages.

pub fn peer(&self, who: &Who) -> Option<Who>

The other session of a direct thread of who. None when this is not a direct thread of who.

use riff_core::name::{ThreadName, Who};

let a = Who::new("mike", Some("a6cf"))?;
let b = Who::new("brett", Some("77e0"))?;
let c = Who::new("mike", None)?;
let thread = ThreadName::direct(&a, &b);
assert_eq!(thread.peer(&a), Some(b.clone()));
assert_eq!(thread.peer(&b), Some(a.clone()));
assert_eq!(thread.peer(&c), None);
assert_eq!(ThreadName::direct(&c, &a).peer(&a), Some(c));

Trait Implementations

impl Clone for ThreadName

fn clone(&self) -> ThreadName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ThreadName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ThreadName

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

Formats the value using the given formatter.

impl From<ThreadName> for String

fn from(name: ThreadName) -> Self

Converts to this type from the input type.

impl FromStr for ThreadName

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

Parses a thread name that a person or an agent typed. Direct-message threads come only from ThreadName::direct.

use riff_core::name::ThreadName;

assert!("como-technologies/riff".parse::<ThreadName>().is_ok());
assert!("two words".parse::<ThreadName>().is_err());
assert!("dm:someone".parse::<ThreadName>().is_err());

type Err = NameError

The associated error which can be returned from parsing.

impl Hash for ThreadName

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 JsonSchema for ThreadName

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

The name of the generated JSON Schema.

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

Generates a JSON Schema for this type.

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.

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

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for ThreadName

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for ThreadName

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

Accepts every thread name on the wire, direct ones included.

type Error = NameError

The type returned in the event of a conversion error.

impl Eq for ThreadName

impl StructuralPartialEq for ThreadName