Enum PlanUpdateContent 

#[non_exhaustive]
pub enum PlanUpdateContent {
    Items(PlanItems),
    File(PlanFile),
    Markdown(PlanMarkdown),
    Other(OtherPlanUpdateContent),
}

Available on crate feature unstable_protocol_v2 only.

Updated content for a plan.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Items(PlanItems)

Structured plan entries.

File(PlanFile)

Available on crate feature unstable_plan_operations only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

A URI pointing to a file containing the plan.

Markdown(PlanMarkdown)

Available on crate feature unstable_plan_operations only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Raw markdown content for the plan.

Other(OtherPlanUpdateContent)

Custom or future plan update content.

Values beginning with _ are reserved for implementation-specific extensions. Unknown values that do not begin with _ are reserved for future ACP variants.

Receivers that do not understand this content type should preserve the raw payload when storing, replaying, proxying, or forwarding plans, and otherwise ignore it or display it generically.

Implementations

impl PlanUpdateContent

pub fn items(id: impl Into<PlanId>, entries: Vec<PlanEntry>) -> Self

Builds a plan update that replaces the itemized entries for a plan.

pub fn file(id: impl Into<PlanId>, uri: impl Into<String>) -> Self

Available on crate feature unstable_plan_operations only.

Builds a plan update that points clients at an external plan file URI.

pub fn markdown(id: impl Into<PlanId>, content: impl Into<String>) -> Self

Available on crate feature unstable_plan_operations only.

Builds a plan update whose plan content is inline Markdown.

Trait Implementations

impl Clone for PlanUpdateContent

fn clone(&self) -> PlanUpdateContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlanUpdateContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlanUpdateContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PlanUpdateContent

impl IntoV1 for PlanUpdateContent

Available on crate feature unstable_plan_operations only.

type Output = PlanUpdateContent

The corresponding v1 type.

fn into_v1(self) -> Result<Self::Output>

Converts this value into the corresponding v1 type.

impl JsonSchema for PlanUpdateContent

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 PlanUpdateContent

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

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 PlanUpdateContent