Struct EventParamSpec

pub struct EventParamSpec<F: Form = MetaForm> { /* private fields */ }

Describes a pair of parameter label and type.

Implementations

impl<F> EventParamSpec<F>

where F: Form, TypeSpec<F>: Default,

pub fn new(label: F::String) -> EventParamSpecBuilder<F>

Creates a new event parameter specification builder.

pub fn label(&self) -> &F::String

Returns the label of the parameter.

pub fn indexed(&self) -> bool

Returns true if the event parameter is indexed as a topic.

pub fn ty(&self) -> &TypeSpec<F>

Returns the type of the parameter.

pub fn docs(&self) -> &[F::String]

Returns the documentation associated with the arguments.

Trait Implementations

impl<F: Debug + Form> Debug for EventParamSpec<F>

where F::String: Debug,

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

Formats the value using the given formatter.

impl<'de, F: Form> Deserialize<'de> for EventParamSpec<F>

where F::Type: DeserializeOwned, F::String: DeserializeOwned,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoPortable for EventParamSpec

type Output = EventParamSpec<PortableForm>

The portable version of Self.

fn into_portable(self, registry: &mut Registry) -> Self::Output

Convert self to the portable form by using the registry for caching.

impl<F: Form + JsonSchema> JsonSchema for EventParamSpec<F>

fn schema_name() -> String

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(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<F: PartialEq + Form> PartialEq for EventParamSpec<F>

where F::String: PartialEq,

fn eq(&self, other: &EventParamSpec<F>) -> 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<F: Form> Serialize for EventParamSpec<F>

where F::Type: Serialize, F::String: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: Eq + Form> Eq for EventParamSpec<F>

where F::String: Eq,

impl<F: Form> StructuralPartialEq for EventParamSpec<F>