Struct CrateSeqLedger 

pub struct CrateSeqLedger {
    pub crate_config: CrateConfig,
    pub settings: LedgerSettings,
    pub auth: LedgerAuth,
    pub entries: Vec<LedgerEntry>,
}

Root structure of a .crate-seq.toml file.

Fields

crate_config: CrateConfig

Crate identity and registry target.

settings: LedgerSettings

Behavioural knobs for the sequencer.

auth: LedgerAuth

Registry authentication configuration.

entries: Vec<LedgerEntry>

All version entries tracked by this ledger.

Implementations

impl CrateSeqLedger

pub fn pending_versions(&self) -> Vec<&LedgerEntry>

Entries with status LedgerStatus::Pending, sorted ascending by version.

pub fn published_versions(&self) -> Vec<&LedgerEntry>

Entries with status LedgerStatus::Published, sorted ascending by version.

pub fn find_version(&self, v: &Version) -> Option<&LedgerEntry>

First entry whose version equals v.

impl CrateSeqLedger

pub fn mark_published(&mut self, version: &Version) -> Result<(), Error>

Marks version as LedgerStatus::Published.

Permitted source states: LedgerStatus::Pending, LedgerStatus::Skipped.

Errors

Returns Error::VersionNotFound if no entry exists for version. Returns Error::InvalidTransition if the entry is LedgerStatus::Published or LedgerStatus::Yanked.

pub fn mark_skipped(&mut self, version: &Version) -> Result<(), Error>

Marks version as LedgerStatus::Skipped.

Permitted source states: LedgerStatus::Pending, LedgerStatus::Skipped, LedgerStatus::Yanked.

Errors

Returns Error::VersionNotFound if no entry exists for version. Returns Error::InvalidTransition if the entry is LedgerStatus::Published.

pub fn mark_yanked(&mut self, version: &Version) -> Result<(), Error>

Marks version as LedgerStatus::Yanked.

Permitted source state: LedgerStatus::Published.

Errors

Returns Error::VersionNotFound if no entry exists for version. Returns Error::InvalidTransition if the entry is not LedgerStatus::Published.

Trait Implementations

impl Clone for CrateSeqLedger

fn clone(&self) -> CrateSeqLedger

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CrateSeqLedger

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CrateSeqLedger

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CrateSeqLedger

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CrateSeqLedger