pub struct MethodExample {
pub params: Value,
pub note: Option<String>,
}Expand description
SYNAPSE-13: one worked call of a method — the params it sends and a note
saying what it does (#[plexus_macros::method(example(note = "…", params = r#"{…}"#))]).
Fields§
§params: ValueThe params object, as the method takes it.
note: Option<String>What the call does, in a line.
Implementations§
Trait Implementations§
Source§impl Clone for MethodExample
impl Clone for MethodExample
Source§impl Debug for MethodExample
impl Debug for MethodExample
Source§impl<'de> Deserialize<'de> for MethodExample
impl<'de> Deserialize<'de> for MethodExample
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
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 JsonSchema for MethodExample
impl JsonSchema for MethodExample
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Returns a string that uniquely identifies the schema produced by this type. Read more
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
Source§fn inline_schema() -> bool
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. Read moreSource§impl PartialEq for MethodExample
impl PartialEq for MethodExample
Source§impl Serialize for MethodExample
impl Serialize for MethodExample
impl StructuralPartialEq for MethodExample
Auto Trait Implementations§
impl Freeze for MethodExample
impl RefUnwindSafe for MethodExample
impl Send for MethodExample
impl Sync for MethodExample
impl Unpin for MethodExample
impl UnsafeUnpin for MethodExample
impl UnwindSafe for MethodExample
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
Mutably borrows from an owned value. Read more