Struct ContractLock 

pub struct ContractLock {
    pub format: u32,
    pub domain: String,
    pub contracts: BTreeMap<String, Value>,
    pub generations: Vec<Generation>,
}

A parsed, integrity-checked lock file.

Fields

format: u32

LOCK_FORMAT.

domain: String

The op-contract domain tag the digests were taken under.

contracts: BTreeMap<String, Value>

Op digest (hex) to that op’s canonical contract.

generations: Vec<Generation>

Oldest first.

Implementations

impl ContractLock

pub fn new() -> ContractLock

A lock with no generations.

pub fn parse(text: &str) -> Result<ContractLock, LockError>

Parse and integrity-check a lock file: format and domain, every stored contract hashing to its key, every generation’s digests present. It does not judge compatibility (see ContractLock::accepted).

pub fn to_json(&self) -> String

The file’s text: pretty JSON ending in a newline.

impl ContractLock

pub fn is_locked(&self, schema: &Schema) -> bool

Whether the schema’s current contract is a recorded generation.

pub fn lock_generation( &mut self, schema: &Schema, locked_at: &str, note: &str, ) -> Result<bool, LockError>

Record the schema’s current contracts as a new generation. Returns false, changing nothing, when that client contract is already a generation (locking is idempotent). locked_at must be a real YYYY-MM-DD date, or LockError::Date and nothing changes.

pub fn incompatible(&self, schema: &Schema) -> Vec<Incompatible>

Every locked contract of a still-existing op whose digest is not the current one and which the current contract is not compatible with.

pub fn accepted( &self, schema: &Schema, ) -> Result<Vec<(String, Vec<[u8; 32]>)>, LockError>

The server’s accepted table: per op key (and batch), the current digest, then every locked digest of that op newest first. Fails with LockError::Incompatible when any locked contract of an existing op is not compatible with the current one, so an incompatible entry is never accepted silently.

impl ContractLock

pub fn prune_op(&mut self, key: &str) -> Pruned

Stop accepting older clients of one op: remove its entry from every generation. This is how a breaking change to an op is shipped on purpose.

pub fn prune_before(&mut self, date: &str) -> Result<Pruned, LockError>

Remove the generations locked before date (a real YYYY-MM-DD date, compared as a date; LockError::Date and nothing removed otherwise).

pub fn prune_keep(&mut self, keep: usize) -> Pruned

Keep only the newest keep generations.

pub fn prune_generation(&mut self, prefix: &str) -> Result<Pruned, LockError>

Remove the one generation whose client contract digest starts with prefix (at least 8 hex digits).

Trait Implementations

impl Clone for ContractLock

fn clone(&self) -> ContractLock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractLock

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

Formats the value using the given formatter.

impl Default for ContractLock

fn default() -> ContractLock

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContractLock

fn deserialize<__D>( __deserializer: __D, ) -> Result<ContractLock, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ContractLock

impl PartialEq for ContractLock

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ContractLock