Struct SessionUri 

pub struct SessionUri { /* private fields */ }

The URI of one session: who, where and what.

It serializes as its full URI. Two URIs of one session differ when the session moves or claims.

use riff_core::name::SessionUri;

let text = "riff://mike@pangolin/como-technologies/riff?session=a6cf&claim=issue-6#pr-23";
let uri: SessionUri = text.parse()?;
assert_eq!(uri.to_string(), text);
assert_eq!(uri.short(), "mike@pangolin:riff#pr-23");
assert_eq!(uri.who().session(), Some("a6cf"));
assert_eq!(uri.claims(), ["issue-6"]);
assert!(!uri.lead());

let lead: SessionUri = "riff://mike@pangolin/como-technologies/riff?session=a6cf&lead=true".parse()?;
assert!(lead.lead());

A query part of a later build (01M3XYYSY536AEJVERBPTQFQYX)

The set of query parts can grow, as lead and claim came. A URI in JSON keeps each query part that this build does not know (SessionUri::other), as it came. The session is the same session: its user, its session ID and its place. The part gives no mark: no lead and no claim. A URI that a person types (FromStr) takes only the parts of this build, and riff-server refuses a call of a caller with such a part.

use riff_core::name::SessionUri;

let known: SessionUri = "riff://ann@heron/acme/app?session=s1".parse()?;
let json = r#""riff://ann@heron/acme/app?session=s1&wave=17&lead=maybe""#;
let later: SessionUri = serde_json::from_str(json).unwrap();
assert_eq!((later.who(), later.place()), (known.who(), known.place()));
assert!(later.is_other() && !later.lead() && later.claims().is_empty());
assert_eq!(later.other(), ["wave=17", "lead=maybe"]);
assert_eq!(serde_json::to_string(&later).unwrap(), json);
assert!(json.trim_matches('"').parse::<SessionUri>().is_err());

Implementations

impl SessionUri

pub fn new(who: Who, place: Place) -> Self

A URI with no claims. It is not the lead.

pub fn other(&self) -> &[String]

Each query part that this build does not know, as it came.

pub fn is_other(&self) -> bool

True for a URI with a query part that this build does not know.

pub fn with_lead(self, lead: bool) -> Self

The same URI, as the lead or not.

pub fn lead(&self) -> bool

True when the session is the lead of its user in its repository.

pub fn with_claims(self, claims: Vec<String>) -> Self

The same URI with these claims, in sorted order.

pub fn who(&self) -> &Who

pub fn place(&self) -> &Place

pub fn claims(&self) -> &[String]

pub fn moved(self, place: Place) -> Self

The same URI in a new place.

pub fn short(&self) -> String

The short form for people: USER@HOST:REPO#WORKTREE.

let main: SessionUri = "riff://mike@pangolin/como-technologies/riff?session=a6cf".parse()?;
assert_eq!(main.short(), "mike@pangolin:riff");
let notes: SessionUri = "riff://mike@pangolin/-?session=a6cf#notes".parse()?;
assert_eq!(notes.short(), "mike@pangolin:-#notes");
let person: SessionUri = "riff://mike@pangolin".parse()?;
assert_eq!(person.short(), "mike@pangolin");

pub fn default_thread(&self) -> Option<ThreadName>

The thread that this session joins by default: OWNER/REPO.

Trait Implementations

impl Clone for SessionUri

fn clone(&self) -> SessionUri

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionUri

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionUri

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SessionUri

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

Formats the value using the given formatter.

impl From<SessionUri> for String

fn from(uri: SessionUri) -> Self

Converts to this type from the input type.

impl FromStr for SessionUri

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

Parses a URI that a person or an agent typed: only the query parts of this build.

type Err = NameError

The associated error which can be returned from parsing.

impl Hash for SessionUri

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 SessionUri

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 SessionUri

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

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

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

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 SessionUri

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

Reads a URI of JSON: a record of the log, or a call. It keeps each query part that this build does not know (01M3XYYSY536AEJVERBPTQFQYX).

type Error = NameError

The type returned in the event of a conversion error.

impl Eq for SessionUri

impl StructuralPartialEq for SessionUri