Struct apollo_compiler::Node

pub struct Node<T>(/* private fields */);

A thread-safe reference-counted smart pointer for GraphQL nodes.

Similar to std::sync::Arc<T> but:

• In addition to T, contains an optional NodeLocation. This location notably allows diagnostics to point to relevant parts of parsed input files.
• std::hash::Hash is implemented by caching the result of hashing T.
• Weak references are not supported.

For the cache to be correct, T is expected to have a stable hash a long as no &mut T exclusive reference to it is given out. Generally this excludes interior mutability.

Node<T> cannot implement Borrow<T> because Node<T> as Hash produces a result (the hash of the cached hash) different from T as Hash.

Implementations

impl<T> Node<T>

pub fn new_parsed(node: T, location: NodeLocation) -> Self

Create a new Node for something parsed from the given source location

pub fn new(node: T) -> Self

Create a new Node for something created programatically, not parsed from a source file

pub fn location(&self) -> Option<NodeLocation>

pub fn is_built_in(&self) -> bool

Whether this node is located in FileId::BUILT_IN, which defines built-in directives, built-in scalars, and introspection types.

pub fn same_location<U>(&self, node: U) -> Node<U>

Returns the given node at the same location as self (e.g. for a type conversion).

pub fn to_component(&self, origin: ComponentOrigin) -> Component<T>

pub fn ptr_eq(&self, other: &Self) -> bool

Returns whether two Nodes point to the same memory allocation

pub fn make_mut(&mut self) -> &mut T

where T: Clone,

Returns a mutable reference to T, cloning it if necessary

This is functionally equivalent to Arc::make_mut from the standard library.

If this Node is uniquely owned, make_mut() will provide a mutable reference to the contents. If not, make_mut() will create a new Node with a clone of the contents, update self to point to it, and provide a mutable reference to its contents.

This is useful for implementing copy-on-write schemes where you wish to avoid copying things if your Node is not shared.

pub fn get_mut(&mut self) -> Option<&mut T>

Returns a mutable reference to T if this Node is uniquely owned

Trait Implementations

impl<T> AsRef<T> for Node<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for Node<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Node<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Node<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for Node<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Display> Display for Node<T>

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

Formats the value using the given formatter.

impl From<&String> for Node<Value>

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Node<Value>

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<()> for Node<Value>

fn from(value: ()) -> Self

Converts to this type from the input type.

impl<N: Into<Name>, V: Into<Node<Value>>> From<(N, V)> for Node<Argument>

fn from((name, value): (N, V)) -> Self

Converts to this type from the input type.

impl From<Node<DirectiveDefinition>> for Definition

fn from(def: Node<DirectiveDefinition>) -> Self

Converts to this type from the input type.

impl From<Node<EnumType>> for ExtendedType

fn from(ty: Node<EnumType>) -> Self

Converts to this type from the input type.

impl From<Node<EnumTypeDefinition>> for Definition

fn from(def: Node<EnumTypeDefinition>) -> Self

Converts to this type from the input type.

impl From<Node<EnumTypeExtension>> for Definition

fn from(def: Node<EnumTypeExtension>) -> Self

Converts to this type from the input type.

impl From<Node<Field>> for Selection

fn from(node: Node<Field>) -> Self

Converts to this type from the input type.

impl From<Node<FragmentDefinition>> for Definition

fn from(def: Node<FragmentDefinition>) -> Self

Converts to this type from the input type.

impl From<Node<FragmentSpread>> for Selection

fn from(node: Node<FragmentSpread>) -> Self

Converts to this type from the input type.

impl From<Node<InlineFragment>> for Selection

fn from(node: Node<InlineFragment>) -> Self

Converts to this type from the input type.

impl From<Node<InputObjectType>> for ExtendedType

fn from(ty: Node<InputObjectType>) -> Self

Converts to this type from the input type.

impl From<Node<InputObjectTypeDefinition>> for Definition

fn from(def: Node<InputObjectTypeDefinition>) -> Self

Converts to this type from the input type.

impl From<Node<InputObjectTypeExtension>> for Definition

fn from(def: Node<InputObjectTypeExtension>) -> Self

Converts to this type from the input type.

impl From<Node<InterfaceType>> for ExtendedType

fn from(ty: Node<InterfaceType>) -> Self

Converts to this type from the input type.

impl From<Node<InterfaceTypeDefinition>> for Definition

fn from(def: Node<InterfaceTypeDefinition>) -> Self

Converts to this type from the input type.

impl From<Node<InterfaceTypeExtension>> for Definition

fn from(def: Node<InterfaceTypeExtension>) -> Self

Converts to this type from the input type.

impl From<Node<ObjectType>> for ExtendedType

fn from(ty: Node<ObjectType>) -> Self

Converts to this type from the input type.

impl From<Node<ObjectTypeDefinition>> for Definition

fn from(def: Node<ObjectTypeDefinition>) -> Self

Converts to this type from the input type.

impl From<Node<ObjectTypeExtension>> for Definition

fn from(def: Node<ObjectTypeExtension>) -> Self

Converts to this type from the input type.

impl From<Node<OperationDefinition>> for Definition

fn from(def: Node<OperationDefinition>) -> Self

Converts to this type from the input type.

impl From<Node<ScalarType>> for ExtendedType

fn from(ty: Node<ScalarType>) -> Self

Converts to this type from the input type.

impl From<Node<ScalarTypeDefinition>> for Definition

fn from(def: Node<ScalarTypeDefinition>) -> Self

Converts to this type from the input type.

impl From<Node<ScalarTypeExtension>> for Definition

fn from(def: Node<ScalarTypeExtension>) -> Self

Converts to this type from the input type.

impl From<Node<SchemaDefinition>> for Definition

fn from(def: Node<SchemaDefinition>) -> Self

Converts to this type from the input type.

impl From<Node<SchemaExtension>> for Definition

fn from(def: Node<SchemaExtension>) -> Self

Converts to this type from the input type.

impl From<Node<UnionType>> for ExtendedType

fn from(ty: Node<UnionType>) -> Self

Converts to this type from the input type.

impl From<Node<UnionTypeDefinition>> for Definition

fn from(def: Node<UnionTypeDefinition>) -> Self

Converts to this type from the input type.

impl From<Node<UnionTypeExtension>> for Definition

fn from(def: Node<UnionTypeExtension>) -> Self

Converts to this type from the input type.

impl From<String> for Node<Value>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<T> From<T> for Node<T>

fn from(node: T) -> Self

Converts to this type from the input type.

impl From<bool> for Node<Value>

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Node<Value>

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Node<Value>

fn from(value: i32) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Node<T>

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<T: PartialEq> PartialEq for Node<T>

fn eq(&self, other: &Self) -> 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<T: Eq> Eq for Node<T>