Struct warpgrapher::engine::objects::Node

pub struct Node<RequestCtx> where
    RequestCtx: Debug + RequestContext,  { /* private fields */ }

Represents a node in the graph data structure for auto-generated CRUD operations and custom resolvers.

Examples

fn custom_resolve(facade: ResolverFacade<()>) -> BoxFuture<ExecutionResult> {
    Box::pin(async move {
        let typename = "User";

        let mut props = HashMap::new();
        props.insert("role".to_string(), Value::String("Admin".to_string()));

        let n = facade.node(typename, props);

        facade.resolve_node(&n).await
    })
}

Implementations

impl<RequestCtx> Node<RequestCtx> where
    RequestCtx: RequestContext, 

pub fn new(
    concrete_typename: String,
    fields: HashMap<String, Value>
) -> Node<RequestCtx>

pub fn deser<T: DeserializeOwned>(&self) -> Result<T, Error>

Attempts to deserialize a Node into a struct.

Example

#[derive(Deserialize)]
struct Team {
    name: String
}

fn handle_node(n: Node<()>) {

    // succeeds if the fields of `n` can be deserialized into `Team`
    let team: Team = n.deser().unwrap();
     
}

pub fn fields(&self) -> &HashMap<String, Value>

Returns the fields of a Node.

Example

use warpgrapher::engine::objects::Node;

fn handle_node(n: Node<()>) {
    let properties = n.fields();
}

pub fn id(&self) -> Result<&Value, Error>

pub fn type_name(&self) -> &String

Trait Implementations

impl<RequestCtx: Clone> Clone for Node<RequestCtx> where
    RequestCtx: Debug + RequestContext, 

fn clone(&self) -> Node<RequestCtx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<RequestCtx: Debug> Debug for Node<RequestCtx> where
    RequestCtx: Debug + RequestContext, 

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

Formats the value using the given formatter.

impl<RequestCtx> GraphQLType<DefaultScalarValue> for Node<RequestCtx> where
    RequestCtx: RequestContext, 

fn name(info: &Self::TypeInfo) -> Option<&str>

Returns name of this GraphQLType to expose.

fn meta<'r>(info: &Self::TypeInfo, registry: &mut Registry<'r>) -> MetaType<'r> where
    DefaultScalarValue: 'r, 

Returns MetaType representing this GraphQLType.

impl<RequestCtx> GraphQLValue<DefaultScalarValue> for Node<RequestCtx> where
    RequestCtx: RequestContext, 

type Context = GraphQLContext<RequestCtx>

Context type for this GraphQLValue.

type TypeInfo = Info

Type that may carry additional schema information for this GraphQLValue.

fn type_name<'i>(&self, info: &'i Self::TypeInfo) -> Option<&'i str>

Returns name of the GraphQLType exposed by this GraphQLValue.

fn concrete_type_name(
    &self,
    _context: &Self::Context,
    info: &Self::TypeInfo
) -> String

Returns the concrete GraphQLType name for this GraphQLValue being an interface, an union or an object.

fn resolve_field(
    &self,
    _info: &Self::TypeInfo,
    _field_name: &str,
    _arguments: &Arguments<'_, S>,
    _executor: &Executor<'_, '_, Self::Context, S>
) -> Result<Value<S>, FieldError<S>>

Resolves the value of a single field on this GraphQLValue.

fn resolve_into_type(
    &self,
    info: &Self::TypeInfo,
    type_name: &str,
    selection_set: Option<&[Selection<'_, S>]>,
    executor: &Executor<'_, '_, Self::Context, S>
) -> Result<Value<S>, FieldError<S>>

Resolves this GraphQLValue (being an interface or an union) into a concrete downstream object type.

fn resolve(
    &self,
    info: &Self::TypeInfo,
    selection_set: Option<&[Selection<'_, S>]>,
    executor: &Executor<'_, '_, Self::Context, S>
) -> Result<Value<S>, FieldError<S>>

Resolves the provided selection_set against this GraphQLValue.

impl<RequestCtx> GraphQLValueAsync<DefaultScalarValue> for Node<RequestCtx> where
    RequestCtx: RequestContext, 

fn resolve_field_async<'a>(
    &'a self,
    info: &'a Self::TypeInfo,
    field_name: &'a str,
    args: &'a Arguments<'_>,
    executor: &'a Executor<'_, '_, Self::Context>
) -> BoxFuture<'a, ExecutionResult>

Resolves the value of a single field on this GraphQLValueAsync.

fn resolve_into_type_async<'a>(
    &'a self,
    info: &'a Self::TypeInfo,
    type_name: &str,
    _selection_set: Option<&'a [Selection<'a>]>,
    executor: &'a Executor<'a, 'a, Self::Context>
) -> BoxFuture<'a, ExecutionResult>

Resolves this GraphQLValueAsync (being an interface or an union) into a concrete downstream object type.

fn resolve_async(
    &'a self,
    info: &'a Self::TypeInfo,
    selection_set: Option<&'a [Selection<'_, S>]>,
    executor: &'a Executor<'_, '_, Self::Context, S>
) -> Pin<Box<dyn Future<Output = Result<Value<S>, FieldError<S>>> + Send + 'a, Global>>

Resolves the provided selection_set against this GraphQLValueAsync.