Skip to main content

ToolRegistration

Struct ToolRegistration 

Source
pub struct ToolRegistration {
    pub aae_version: String,
    pub name: String,
    pub description: Option<String>,
    pub plan_schema: Value,
    pub preview_schema: Option<Value>,
    pub preview_supported: bool,
    pub default_blast_radius: BlastRadius,
    pub aae_required: bool,
    pub data_classes_touched: Vec<String>,
    pub compliance_relevant: bool,
    pub systems_of_record: Vec<String>,
    pub reversibility: Option<Reversibility>,
}
Expand description

Tool registration declaring the tool’s plan/preview contract.

Fields§

§aae_version: String

Protocol version.

§name: String

Tool name (matched against Step.tool).

§description: Option<String>

Optional human-readable description.

§plan_schema: Value

JSON Schema for the args object of a step using this tool.

§preview_schema: Option<Value>

Optional JSON Schema for predicted_effects produced by this tool.

§preview_supported: bool

Whether this tool supports preview.

§default_blast_radius: BlastRadius

Default blast radius if step does not declare one.

§aae_required: bool

Whether this tool requires the AAE lifecycle.

§data_classes_touched: Vec<String>

v0.3 optional (G-4): opaque data-class identifiers this tool may touch.

§compliance_relevant: bool

v0.3 optional (G-4): whether operations are compliance-relevant.

§systems_of_record: Vec<String>

v0.3 optional (G-4): systems of record this tool can modify.

§reversibility: Option<Reversibility>

v0.3 optional (G-4): whether this tool’s effects can be undone.

Trait Implementations§

Source§

impl Clone for ToolRegistration

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolRegistration

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ToolRegistration

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ToolRegistration

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.