Struct async_graphql::Request

#[non_exhaustive]
pub struct Request {
    pub query: String,
    pub operation_name: Option<String>,
    pub variables: Variables,
    pub uploads: Vec<UploadValue>,
    pub data: Data,
    pub extensions: HashMap<String, Value>,
    pub introspection_mode: IntrospectionMode,
    /* private fields */
}

GraphQL request.

This can be deserialized from a structure of the query string, the operation name and the variables. The names are all in camelCase (e.g. operationName).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

query: String

The query source of the request.

operation_name: Option<String>

The operation name of the request.

variables: Variables

The variables of the request.

uploads: Vec<UploadValue>

Uploads sent with the request.

data: Data

The data of the request that can be accessed through Context::data.

This data is only valid for this request

extensions: HashMap<String, Value>

The extensions config of the request.

introspection_mode: IntrospectionMode

Sets the introspection mode for this request (defaults to IntrospectionMode::Enabled).

Implementations

impl Request

pub fn new(query: impl Into<String>) -> Self

Create a request object with query source.

Examples found in repository

src/request.rs (line 162)

    fn from(query: T) -> Self {
        Self::new(query)
    }

src/http/mod.rs (line 58)

pub fn parse_query_string(input: &str) -> Result<Request, ParseRequestError> {
    #[derive(Deserialize)]
    struct RequestSerde {
        #[serde(default)]
        pub query: String,
        pub operation_name: Option<String>,
        pub variables: Option<String>,
        pub extensions: Option<String>,
    }

    let request: RequestSerde = serde_urlencoded::from_str(input)
        .map_err(|err| std::io::Error::new(ErrorKind::Other, err))?;
    let variables = request
        .variables
        .map(|data| serde_json::from_str(&data))
        .transpose()
        .map_err(|err| {
            std::io::Error::new(ErrorKind::Other, format!("invalid variables: {}", err))
        })?
        .unwrap_or_default();
    let extensions = request
        .extensions
        .map(|data| serde_json::from_str(&data))
        .transpose()
        .map_err(|err| {
            std::io::Error::new(ErrorKind::Other, format!("invalid extensions: {}", err))
        })?
        .unwrap_or_default();

    Ok(Request {
        operation_name: request.operation_name,
        variables,
        extensions,
        ..Request::new(request.query)
    })
}

pub fn operation_name<T: Into<String>>(self, name: T) -> Self

Specify the operation name of the request.

pub fn variables(self, variables: Variables) -> Self

Specify the variables.

pub fn data<D: Any + Send + Sync>(self, data: D) -> Self

Insert some data for this request.

pub fn disable_introspection(self) -> Self

Disable introspection queries for this request.

pub fn only_introspection(self) -> Self

Only allow introspection queries for this request.

pub fn parsed_query(&mut self) -> Result<&ExecutableDocument, ServerError>

Performs parsing of query ahead of execution.

This effectively allows to inspect query information, before passing request to schema for execution as long as query is valid.

pub fn set_upload(&mut self, var_path: &str, upload: UploadValue)

Set a variable to an upload value.

var_path is a dot-separated path to the item that begins with variables, for example variables.files.2.content is equivalent to the Rust code request.variables["files"][2]["content"]. If no variable exists at the path this function won’t do anything.

Examples found in repository

src/http/multipart.rs (line 156)

pub(super) async fn receive_batch_multipart(
    body: impl AsyncRead + Send,
    boundary: impl Into<String>,
    opts: MultipartOptions,
) -> Result<BatchRequest, ParseRequestError> {
    let mut multipart = Multipart::with_constraints(
        ReaderStream::new(body),
        boundary,
        Constraints::new().size_limit({
            let mut limit = SizeLimit::new();
            if let (Some(max_file_size), Some(max_num_files)) =
                (opts.max_file_size, opts.max_num_files)
            {
                limit = limit.whole_stream((max_file_size * max_num_files) as u64);
            }
            if let Some(max_file_size) = opts.max_file_size {
                limit = limit.per_field(max_file_size as u64);
            }
            limit
        }),
    );

    let mut request = None;
    let mut map = None;
    let mut files = Vec::new();

    while let Some(field) = multipart.next_field().await? {
        // in multipart, each field / file can actually have a own Content-Type.
        // We use this to determine the encoding of the graphql query
        let content_type = field
            .content_type()
            // default to json
            .unwrap_or(&mime::APPLICATION_JSON)
            .clone();
        match field.name() {
            Some("operations") => {
                let body = field.bytes().await?;
                request = Some(
                    super::receive_batch_body_no_multipart(&content_type, body.as_ref()).await?,
                )
            }
            Some("map") => {
                let map_bytes = field.bytes().await?;

                match (content_type.type_(), content_type.subtype()) {
                    // cbor is in application/octet-stream.
                    // TODO: wait for mime to add application/cbor and match against that too
                    // Note: we actually differ here from the inoffical spec for this:
                    // (https://github.com/jaydenseric/graphql-multipart-request-spec#multipart-form-field-structure)
                    // It says: "map: A JSON encoded map of where files occurred in the operations.
                    // For each file, the key is the file multipart form field name and the value is
                    // an array of operations paths." However, I think, that
                    // since we accept CBOR as operation, which is valid, we should also accept it
                    // as the mapping for the files.
                    #[cfg(feature = "cbor")]
                    (mime::OCTET_STREAM, _) | (mime::APPLICATION, mime::OCTET_STREAM) => {
                        map = Some(
                            serde_cbor::from_slice::<HashMap<String, Vec<String>>>(&map_bytes)
                                .map_err(|e| ParseRequestError::InvalidFilesMap(Box::new(e)))?,
                        );
                    }
                    // default to json
                    _ => {
                        map = Some(
                            serde_json::from_slice::<HashMap<String, Vec<String>>>(&map_bytes)
                                .map_err(|e| ParseRequestError::InvalidFilesMap(Box::new(e)))?,
                        );
                    }
                }
            }
            _ => {
                if let Some(name) = field.name().map(ToString::to_string) {
                    if let Some(filename) = field.file_name().map(ToString::to_string) {
                        let content_type = field.content_type().map(ToString::to_string);

                        #[cfg(feature = "tempfile")]
                        let content = {
                            use std::io::{Seek, SeekFrom, Write};

                            let mut field = field;
                            let mut file = tempfile::tempfile().map_err(ParseRequestError::Io)?;
                            while let Some(chunk) = field.chunk().await? {
                                file.write(&chunk).map_err(ParseRequestError::Io)?;
                            }
                            file.seek(SeekFrom::Start(0))?;
                            file
                        };

                        #[cfg(not(feature = "tempfile"))]
                        let content = field.bytes().await?;

                        files.push((name, filename, content_type, content));
                    }
                }
            }
        }
    }

    let mut request: BatchRequest = request.ok_or(ParseRequestError::MissingOperatorsPart)?;
    let map = map.as_mut().ok_or(ParseRequestError::MissingMapPart)?;

    for (name, filename, content_type, file) in files {
        if let Some(var_paths) = map.remove(&name) {
            let upload = UploadValue {
                filename,
                content_type,
                content: file,
            };

            for var_path in var_paths {
                match &mut request {
                    BatchRequest::Single(request) => {
                        request.set_upload(&var_path, upload.try_clone()?);
                    }
                    BatchRequest::Batch(requests) => {
                        let mut s = var_path.splitn(2, '.');
                        let idx = s.next().and_then(|idx| idx.parse::<usize>().ok());
                        let path = s.next();

                        if let (Some(idx), Some(path)) = (idx, path) {
                            if let Some(request) = requests.get_mut(idx) {
                                request.set_upload(path, upload.try_clone()?);
                            }
                        }
                    }
                }
            }
        }
    }

    if !map.is_empty() {
        return Err(ParseRequestError::MissingFiles);
    }

    Ok(request)
}

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Request> for BatchRequest

fn from(r: Request) -> Self

Converts to this type from the input type.

impl<T: Into<String>> From<T> for Request

fn from(query: T) -> Self

Converts to this type from the input type.

impl Serialize for Request

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

Serialize this value into the given Serde serializer.