Struct RepositoryUses 

pub struct RepositoryUses { /* private fields */ }

A uses: some/repo clause.

Implementations

impl RepositoryUses

pub fn new( owner: String, dependent_builder: impl for<'_q> FnOnce(&'_q String) -> RepositoryUsesInner<'_q>, ) -> Self

Constructs a new self-referential struct.

The provided owner will be moved into a heap allocated box. Followed by construction of the dependent value, by calling dependent_builder with a shared reference to the owner that remains valid for the lifetime of the constructed struct.

pub fn try_new<Err>( owner: String, dependent_builder: impl for<'_q> FnOnce(&'_q String) -> Result<RepositoryUsesInner<'_q>, Err>, ) -> Result<Self, Err>

Constructs a new self-referential struct or returns an error.

Consumes owner on error.

pub fn try_new_or_recover<Err>( owner: String, dependent_builder: impl for<'_q> FnOnce(&'_q String) -> Result<RepositoryUsesInner<'_q>, Err>, ) -> Result<Self, (String, Err)>

Constructs a new self-referential struct or returns an error.

Returns owner and error as tuple on error.

pub fn borrow_owner<'_q>(&'_q self) -> &'_q String

Borrows owner.

pub fn with_dependent<'outer_fn, Ret>( &'outer_fn self, func: impl for<'_q> FnOnce(&'_q String, &'outer_fn RepositoryUsesInner<'_q>) -> Ret, ) -> Ret

Calls given closure func with a shared reference to dependent.

pub fn with_dependent_mut<'outer_fn, Ret>( &'outer_fn mut self, func: impl for<'_q> FnOnce(&'_q String, &'outer_fn mut RepositoryUsesInner<'_q>) -> Ret, ) -> Ret

Calls given closure func with an unique reference to dependent.

pub fn borrow_dependent<'_q>(&'_q self) -> &'_q RepositoryUsesInner<'_q>

Borrows dependent.

pub fn into_owner(self) -> String

Consumes self and returns the the owner.

impl RepositoryUses

pub fn parse(uses: impl Into<String>) -> Result<Self, UsesError>

Parse a uses: some/repo clause.

pub fn raw(&self) -> &str

Get the raw uses: string.

pub fn owner(&self) -> &str

Get the owner (user or org) of this repository uses: clause.

pub fn repo(&self) -> &str

Get the repository name of this repository uses: clause.

pub fn slug(&self) -> &str

Get the owner/repo slug of this repository uses: clause.

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

Get the optional subpath of this repository uses: clause.

pub fn git_ref(&self) -> &str

Get the git ref (branch, tag, or SHA) of this repository uses: clause.

Trait Implementations

impl Debug for RepositoryUses

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

Formats the value using the given formatter.

impl Display for RepositoryUses

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

Formats the value using the given formatter.

impl Drop for RepositoryUses

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for RepositoryUses

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