Struct apollo_compiler::schema::Component

pub struct Component<T> {
    pub origin: ComponentOrigin,
    pub node: Node<T>,
}

A component of a type or schema, for example a field of an object type.

Wraps a Node<T> and adds its origin: either a (schema or type) definition or a specific extension.

Implements Deref and DerefMut so that methods and fields of Node<T> and T can be accessed directly.

Fields

origin: ComponentOrigin

node: Node<T>

Implementations

impl<T> Component<T>

pub fn new(node: T) -> Self

Mark node as coming from a synthetic (no source location) definition (not an extension)

Methods from Deref<Target = Node<T>>

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 Component<T>

fn as_ref(&self) -> &T

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

impl<T: Clone> Clone for Component<T>

fn clone(&self) -> Component<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Component<T>

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

Formats the value using the given formatter.

impl<T> Deref for Component<T>

type Target = Node<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Component<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> From<T> for Component<T>

fn from(node: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Component<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 Component<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 Component<T>