Struct async_graphql::types::Upload

pub struct Upload(pub usize);

Uploaded file

Reference: https://github.com/jaydenseric/graphql-multipart-request-spec

Graphql supports file uploads via multipart/form-data. Enable this feature by accepting an argument of type Upload (single file) or Vec<Upload> (multiple files) in your mutation like in the example blow.

Example

Full Example

use async_graphql::*;

struct Mutation;

#[Object]
impl Mutation {
    async fn upload(&self, ctx: &Context<'_>, file: Upload) -> bool {
        println!("upload: filename={}", file.value(ctx).unwrap().filename);
        true
    }
}

Example Curl Request

Assuming you have defined your Mutation like in the example above, you can now upload a file myFile.txt with the below curl command:

curl 'localhost:8000' \
--form 'operations={
        "query": "mutation ($file: Upload!) { upload(file: $file)  }",
        "variables": { "file": null }}' \
--form 'map={ "0": ["variables.file"] }' \
--form '0=@myFile.txt'

Tuple Fields

0: usize

Implementations

impl Upload

pub fn value(&self, ctx: &Context<'_>) -> Result<UploadValue>

Get the upload value.

Methods from Deref<Target = usize>

pub const MIN: usize = 0usize

pub const MAX: usize = 18_446_744_073_709_551_615usize

pub const BITS: u32 = 64u32

Trait Implementations

impl Clone for Upload

fn clone(&self) -> Upload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Upload

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

Formats the value using the given formatter.

impl Deref for Upload

type Target = usize

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for Upload

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl InputType for Upload

type RawValueType = Upload

The raw type used for validator.

fn type_name() -> Cow<'static, str>

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

fn parse(value: Option<Value>) -> InputValueResult<Self>

Parse from Value. None represents undefined.

fn to_value(&self) -> Value

Convert to a Value for introspection.

fn as_raw_value(&self) -> Option<&Self::RawValueType>

Returns a reference to the raw value.

fn qualified_type_name() -> String

Qualified typename.

impl Ord for Upload

fn cmp(&self, other: &Upload) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Upload

fn eq(&self, other: &Upload) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Upload

fn partial_cmp(&self, other: &Upload) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Upload

impl Eq for Upload

impl StructuralPartialEq for Upload