#[non_exhaustive]pub struct PlanMarkdown {
pub plan_id: PlanId,
pub content: String,
pub path: Option<PathBuf>,
pub meta: Option<Map<String, Value>>,
}Expand description
A plan represented as Markdown.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.plan_id: PlanIdThe plan ID to update.
content: StringThe complete plan as Markdown, not just the text that changed.
path: Option<PathBuf>The absolute path of the file that holds this plan.
Omitted and null both mean the plan has no file. A supplied path MUST
be absolute. content is the plan to display whether or not path is set.
Clients can use path to open the file.
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§
Source§impl PlanMarkdown
impl PlanMarkdown
Sourcepub fn new(
plan_id: impl Into<PlanId>,
content: impl Into<String>,
) -> PlanMarkdown
pub fn new( plan_id: impl Into<PlanId>, content: impl Into<String>, ) -> PlanMarkdown
Builds PlanMarkdown with the required fields set. Optional fields start unset or empty.
Sourcepub fn path(self, path: impl IntoOption<PathBuf>) -> PlanMarkdown
pub fn path(self, path: impl IntoOption<PathBuf>) -> PlanMarkdown
The absolute path of the file that holds this plan.
content is the plan to display whether or not path is set.
Sourcepub fn meta(self, meta: impl IntoOption<Map<String, Value>>) -> PlanMarkdown
pub fn meta(self, meta: impl IntoOption<Map<String, Value>>) -> PlanMarkdown
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§
Source§impl Clone for PlanMarkdown
impl Clone for PlanMarkdown
Source§fn clone(&self) -> PlanMarkdown
fn clone(&self) -> PlanMarkdown
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for PlanMarkdown
impl Debug for PlanMarkdown
Source§impl<'de> Deserialize<'de> for PlanMarkdown
impl<'de> Deserialize<'de> for PlanMarkdown
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<PlanMarkdown, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<PlanMarkdown, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
impl Eq for PlanMarkdown
Source§impl JsonSchema for PlanMarkdown
impl JsonSchema for PlanMarkdown
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read moreSource§impl PartialEq for PlanMarkdown
impl PartialEq for PlanMarkdown
Source§impl Serialize for PlanMarkdown
impl Serialize for PlanMarkdown
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl StructuralPartialEq for PlanMarkdown
Auto Trait Implementations§
impl Forget for PlanMarkdown
impl Freeze for PlanMarkdown
impl Move for PlanMarkdown
impl RefUnwindSafe for PlanMarkdown
impl Send for PlanMarkdown
impl Sync for PlanMarkdown
impl Unpin for PlanMarkdown
impl UnsafeUnpin for PlanMarkdown
impl UnwindSafe for PlanMarkdown
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.