Struct SubtreeConfig

pub struct SubtreeConfig { /* private fields */ }

Configuration for a subtree

Implementations

impl SubtreeConfig

pub fn id(&self) -> &String

subtree id

pub fn follow(&self) -> &Option<String>

Follow schema for subtree

pub fn origin(&self) -> &Option<String>

Origin remote for subtree

pub fn upstream(&self) -> &Option<String>

Upstream remote for subtree

pub fn pull_pre_releases(&self) -> &bool

true if this subtree should also pull pre release tags e.g. “1.0.3-23-alpah”

impl SubtreeConfig

pub const fn new( id: String, follow: Option<String>, origin: Option<String>, upstream: Option<String>, pull_pre_releases: bool, ) -> Self

Return a new instance

pub const fn is_pullable(&self) -> bool

Return true if upstream is set

pub const fn is_pushable(&self) -> bool

Return true if origin is set

pub fn config_file(&self) -> String

Return path to config file

pub fn name(&self) -> String

Subtree name

pub fn ref_to_pull(&self) -> Result<String, PosixError>

Figure out which named ref to pull from.

Panics

Will panic if &self has no upstream remote defined

Errors

Will return a PosixError when fails to find a ref to pull

Trait Implementations

impl Clone for SubtreeConfig

fn clone(&self) -> SubtreeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubtreeConfig

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

Formats the value using the given formatter.

impl Ord for SubtreeConfig

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

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

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

impl StructuralPartialEq for SubtreeConfig