Struct async_graphql::Upload

pub struct Upload {
    pub filename: String,
    pub content_type: Option<String>,
    pub content: Vec<u8>,
}

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::Upload;

struct MutationRoot;

#[async_graphql::Object]
impl MutationRoot {
    #[field]
    async fn upload(&self, file: Upload) -> bool {
        println!(
            "upload: filename={} size={}",
            file.filename,
            file.content.len()
        );
        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'

Fields

filename: String

Filename

content_type: Option<String>

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

content: Vec<u8>

File content

Trait Implementations

impl<'a> 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

fn global_id(id: ID) -> ID

Returns a GlobalID that is unique among all types.

fn from_global_id(id: ID) -> Option<ID>

Parse GlobalID.