Struct ChangeMetadata 

pub struct ChangeMetadata {
    pub meta_version: u32,
    pub change_id: String,
    pub title: Option<String>,
    pub status: ChangeStatus,
    pub schema: String,
    pub notebook: String,
    pub created_at: Timestamp,
    pub updated_at: Timestamp,
    pub repository_commits: Vec<RepositoryCommit>,
}

The JSON control plane stored in a change’s meta note.

Fields

meta_version: u32

Meta note format version.

change_id: String

Change identifier (the namespace folder name).

title: Option<String>

Human-readable title.

status: ChangeStatus

Lifecycle status.

schema: String

Workflow schema name resolved for this change.

notebook: String

Source notebook holding the change.

created_at: Timestamp

Creation time.

updated_at: Timestamp

Last update time.

repository_commits: Vec<RepositoryCommit>

Commits recorded at repository-writing transitions.

Implementations

impl ChangeMetadata

pub fn new( change_id: &str, title: Option<&str>, schema: &str, notebook: &str, ) -> Result<Self, ChangeError>

Creates metadata for a new draft change stamped with the current time.

Errors

Returns ChangeError::InvalidChangeId for non-kebab-case ids.

pub fn transition(&mut self, next: ChangeStatus) -> Result<(), ChangeError>

Moves the change to next and refreshes updated_at.

Errors

Returns ChangeError::InvalidTransition when the lifecycle does not permit the move.

pub fn record_commit(&mut self, commit: &str)

Records a repository commit produced by a repository-writing operation and refreshes updated_at.

Trait Implementations

impl Clone for ChangeMetadata

fn clone(&self) -> ChangeMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChangeMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ChangeMetadata

impl PartialEq for ChangeMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ChangeMetadata

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 ChangeMetadata