Struct DiffChange 

#[non_exhaustive]
pub struct DiffChange {
    pub file_type: Option<DiffFileType>,
    pub mime_type: Option<String>,
    pub operation: DiffChangeOperation,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

One file-level change described by a Diff.

Structured change metadata lets clients identify affected files and operations without parsing the text patch.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

file_type: Option<DiffFileType>

File content kind.

Omitted or null means the content kind is unknown.

mime_type: Option<String>

MIME type of the file contents.

Omitted or null means the MIME type is unknown.

operation: DiffChangeOperation

File operation-specific fields.

meta: Option<Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl DiffChange

pub fn new(operation: DiffChangeOperation) -> DiffChange

Builds DiffChange with the required fields set; optional fields start unset or empty.

pub fn add(path: impl Into<PathBuf>) -> DiffChange

Builds a file add change.

pub fn delete(path: impl Into<PathBuf>) -> DiffChange

Builds a file delete change.

pub fn modify(path: impl Into<PathBuf>) -> DiffChange

Builds a file modify change.

pub fn move_file( old_path: impl Into<PathBuf>, path: impl Into<PathBuf>, ) -> DiffChange

Builds a file move or rename change.

pub fn copy( old_path: impl Into<PathBuf>, path: impl Into<PathBuf>, ) -> DiffChange

Builds a file copy change.

pub fn file_type(self, file_type: impl IntoOption<DiffFileType>) -> DiffChange

File content kind.

Omitted or null means the content kind is unknown.

pub fn mime_type(self, mime_type: impl IntoOption<String>) -> DiffChange

MIME type of the file contents.

Omitted or null means the MIME type is unknown.

pub fn meta(self, meta: impl IntoOption<Map<String, Value>>) -> DiffChange

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations

impl Clone for DiffChange

fn clone(&self) -> DiffChange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiffChange

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DiffChange

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DiffChange

impl JsonSchema for DiffChange

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for DiffChange

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

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 DiffChange