Enum QueriedFields

pub enum QueriedFields {
    All,
    Fields(Vec<String>),
}

This type represents the fields queried by a request.

Nested fields are allowed using a dot (.) separator.

vec![
  "fieldOne",
  "fieldTwo.child",
  "fieldTwo.otherChild.field"
];

It’s serialized as an optional Vec<String> so it can be directly used in query strings or bodies.

Variants

All

Query all the fields available

Fields(Vec<String>)

query just the listed fields

Implementations

impl QueriedFields

pub fn all_fields_queried(&self) -> bool

Returns wether every field is being queried or not

pub fn is_empty(&self) -> bool

Checks wether no fields are being queried

pub fn contains(&self, field: &str) -> bool

Checks if a given field is being queried.

Examples:

let query = QueriedFields::from(vec!["a", "a.b.c", "a.b.d", "b", "c.d"]);

assert!(query.contains("a"));
assert!(query.contains("a.b"));
assert!(!query.contains("d"));

pub fn other_than(&self, fields: &[&str]) -> bool

Checks if there are other top-level fields queried not present on the list.

This method will return true always if all fields are queried, no matter if you manually provide all of them.

Examples:

let query = QueriedFields::from(vec!["a", "b", "b.d", "c"]);

assert!(query.other_than(&["a", "b"]));
assert!(!query.other_than(&["a", "b", "c"]));

pub fn child(&self, field: &str) -> QueriedFields

Returns the QueriedFields for a given child field.

Examples:

let query = QueriedFields::from(vec!["a", "a.b.c", "a.b.d", "b", "c.d"]);

assert!(query.child("d").is_empty());
assert!(query.child("a.b").contains("c"));
assert!(query.child("a.b").contains("d"));

pub fn nodes(&self) -> QueriedFields

Returns the QueriedFields for the Edge’s node in a Page.

Examples:

let query = QueriedFields::from(vec![
    "pageInfo.hasNextCursor",
    "pageInfo.endCursor",
    "totalItems",
    "edges.node.a",
    "nodes.b",
]);

assert!(query.nodes().contains("a"));
assert!(query.nodes().contains("b"));
assert!(!query.nodes().contains("c"));

pub fn entry_values(&self) -> QueriedFields

Returns the QueriedFields for the GraphQLMap’s entry values.

It’s really a shortcut to .child("value")

Examples:

let query = QueriedFields::from(vec!["a", "b.key", "b.value.c", "b.value.d"]);

assert!(query.child("b").entry_values().contains("c"));
assert!(query.child("b").entry_values().contains("d"));

Trait Implementations

impl Clone for QueriedFields

fn clone(&self) -> QueriedFields

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueriedFields

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueriedFields

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&[&str]> for QueriedFields

fn from(value: &[&str]) -> Self

Converts to this type from the input type.

impl From<&[String]> for QueriedFields

fn from(value: &[String]) -> Self

Converts to this type from the input type.

impl From<Option<Vec<String>>> for QueriedFields

fn from(value: Option<Vec<String>>) -> Self

Converts to this type from the input type.

impl From<QueriedFields> for Option<Vec<String>>

fn from(value: QueriedFields) -> Self

Converts to this type from the input type.

impl From<Vec<&str>> for QueriedFields

fn from(value: Vec<&str>) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for QueriedFields

fn from(value: Vec<String>) -> Self

Converts to this type from the input type.

impl PartialEq for QueriedFields

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for QueriedFields

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for QueriedFields

impl StructuralPartialEq for QueriedFields