Struct async_graphql::types::Upload

pub struct Upload(_);

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 MutationRoot;

#[GQLObject]
impl MutationRoot {
    async fn upload(&self, file: Upload) -> bool {
        println!("upload: filename={}", file.filename());
        true
    }
}

Example Curl Request

Assuming you have defined your MutationRoot 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'

Implementations

impl Upload

pub fn filename(&self) -> &str

Filename

pub fn content_type(&self) -> Option<&str>

Content type, such as application/json, image/jpg ...

pub fn size(&self) -> Result<u64>

Returns the size of the file, in bytes.

pub fn into_read(self) -> impl Read + Sync + Send + 'static

Convert to a Read.

Note: this is a synchronous/blocking reader.

Trait Implementations

impl InputValueType for Upload

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

Parse from Value. None represents undefined.

fn to_value(&self) -> Value

Convert to a Value for introspection.

impl Type for Upload

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 qualified_type_name() -> String

Qualified typename.

fn introspection_type_name(&self) -> Cow<'static, str>

Introspection type name