Struct EdgePreExecutionArguments

Source
pub struct EdgePreExecutionArguments { /* private fields */ }
Expand description

Arguments passed to the authorize_edge_pre_execution hook.

Implementations§

Source§

impl EdgePreExecutionArguments

Source

pub fn parent_type_name(&self) -> &str

The name of the parent type of the edge.

For the following GraphQL schema:

type Query {
    user(id: ID!): User @authorized(arguments: "id")
}

The parent type name is Query.

Source

pub fn field_name(&self) -> &str

The name of the authorized edge.

For the following GraphQL schema:

type Query {
    user(id: ID!): User @authorized(arguments: "id")
}

The field name is user.

Source

pub fn arguments<'a, T>(&'a self) -> Result<T, Error>
where T: Deserialize<'a>,

The arguments passed to the @authorized directive. The arguments are serialized as a JSON object. This method will deserialize the arguments into either serde_json::Value or a custom struct.

For the following GraphQL schema:

type Query {
    user(id: ID!): User @authorized(arguments: "id")
}

When executing a query like:

query {
  user(id: "123") { id }
}

The arguments are {"id": "123"}.

The arguments can be deserialized into a custom struct like:

#[derive(serde::Deserialize)]
struct Arguments {
   id: String,
}

let arguments: Arguments = arguments.arguments()?;
Source

pub fn metadata<'a, T>(&'a self) -> Result<T, Error>
where T: Deserialize<'a>,

The metadata passed to the @authorized directive. The metadata is serialized as a JSON object. This method will deserialize the metadata into either serde_json::Value or a custom struct.

For the following GraphQL schema:

type Query {
    user(id: ID!): User @authorized(arguments: "id", metadata: { role: "admin" })
}

When executing a query like:

query {
  user(id: "123") { id }
}

The metadata is {"role": "admin"}.

The metadata can be deserialized into a custom struct like:

#[derive(serde::Deserialize)]
#[serde(untagged, rename = "snake_case")]
enum Role {
   Admin,
   User,
}

#[derive(serde::Deserialize)]
struct Metadata {
   role: Role,
}

let arguments: Metadata = arguments.metadata()?;

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.