Struct EditPlan 

pub struct EditPlan {
    pub schema_version: String,
    pub operation: String,
    pub files: Vec<FileEdit>,
    pub completeness: Option<Completeness>,
    pub extensions: BTreeMap<String, Value>,
}

Versioned, extensible multi-file edit-plan envelope.

Decoding retains every undeclared member at all three levels so a v1 consumer can round-trip extensions it does not interpret. A consumer that only validates or applies the plan can decode through DeclaredEditPlan and skip that work.

Fields

schema_version: String

operation: String

files: Vec<FileEdit>

completeness: Option<Completeness>

extensions: BTreeMap<String, Value>

Implementations

impl EditPlan

pub fn new(operation: impl Into<String>, files: Vec<FileEdit>) -> Self

pub fn validate(&self) -> Result<ValidatedEditPlan<'_>, EditError>

pub fn validate_with( &self, limits: PlanLimits, ) -> Result<ValidatedEditPlan<'_>, EditError>

Trait Implementations

impl AsRef<EditPlan> for DeclaredEditPlan

fn as_ref(&self) -> &EditPlan

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for EditPlan

fn clone(&self) -> EditPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EditPlan

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EditPlan

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DeclaredEditPlan> for EditPlan

fn from(declared: DeclaredEditPlan) -> Self

Converts to this type from the input type.

impl PartialEq for EditPlan

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EditPlan

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 EditPlan