Struct Place 

pub struct Place { /* private fields */ }

Where a session works: a host, a repository and a worktree.

use riff_core::name::{Place, Repo};

let repo = Repo::Git { owner: "como-technologies".into(), name: "riff".into() };
let place = Place::new("pangolin", repo, Some("pr-23"))?;
assert_eq!(place.repo_text(), "como-technologies/riff");
assert_eq!(place.default_thread().unwrap().to_string(), "como-technologies/riff");

// A person has a host and nothing else.
assert!(Place::host_only("pangolin")?.default_thread().is_none());

Implementations

impl Place

pub fn new( host: &str, repo: Repo, worktree: Option<&str>, ) -> Result<Self, NameError>

pub fn host_only(host: &str) -> Result<Self, NameError>

The place of a person on the command line: a host only.

pub fn host(&self) -> &str

pub fn repo(&self) -> &Repo

pub fn worktree(&self) -> Option<&str>

pub fn repo_text(&self) -> String

OWNER/REPO, or - outside git.

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

The thread that a session joins in this place: OWNER/REPO. Outside git there is none.

Trait Implementations

impl Clone for Place

fn clone(&self) -> Place

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Place

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

Formats the value using the given formatter.

impl Hash for Place

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 Place

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

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

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

impl StructuralPartialEq for Place