Struct BookmarkName 

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

A validated jj bookmark name (jj’s equivalent of a git branch). Every JjApi operation that names a bookmark to create, move, rename, delete, track, fetch, or push takes a BookmarkName, so a name from untrusted input is validated once, at construction. jj bookmark names are permissive, so the guarantee is the load-bearing one: non-empty and not flag-shaped (no leading -), matching the injection guard these operations applied internally before. The typed methods additionally wrap the name in jj’s exact: string pattern so a */? in a name can never fan the operation out across every bookmark. A rejected name is an vcs_cli_support::is_invalid_input failure.

Implementations

impl BookmarkName

pub fn new(name: impl Into<String>) -> Result<Self>

Validate name as a bookmark name (non-empty, no leading -).

pub fn as_str(&self) -> &str

The validated name.

Trait Implementations

impl Clone for BookmarkName

fn clone(&self) -> BookmarkName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BookmarkName

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

Formats the value using the given formatter.

impl Display for BookmarkName

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

Formats the value using the given formatter.

impl Eq for BookmarkName

impl FromStr for BookmarkName

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for BookmarkName

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 PartialEq for BookmarkName

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BookmarkName