pub struct ResponseBuilder<'a, 'doc, 'schema> { /* private fields */ }Expand description
Builds a GraphQL response which matches the shape of a given executable GraphQL document.
Documentation of the response format can be found in the GraphQL spec.
Implementations§
Source§impl<'a, 'doc, 'schema> ResponseBuilder<'a, 'doc, 'schema>
impl<'a, 'doc, 'schema> ResponseBuilder<'a, 'doc, 'schema>
pub fn new( u: &'a mut Unstructured<'a>, doc: &'doc Valid<ExecutableDocument>, schema: &'schema Valid<Schema>, ) -> Self
Sourcepub fn with_custom_scalar(self, scalar_name: Name, generator: Generator) -> Self
pub fn with_custom_scalar(self, scalar_name: Name, generator: Generator) -> Self
Register a generator function for generating custom scalar values.
Sourcepub fn with_min_list_size(self, min_size: usize) -> Self
pub fn with_min_list_size(self, min_size: usize) -> Self
Set the minimum number of items per list field. If unset, defaults to 0.
Sourcepub fn with_max_list_size(self, max_size: usize) -> Self
pub fn with_max_list_size(self, max_size: usize) -> Self
Set the maximum number of items per list field. If unset, defaults to 5.
Sourcepub fn with_null_ratio(self, numerator: u8, denominator: u8) -> Self
pub fn with_null_ratio(self, numerator: u8, denominator: u8) -> Self
Set the frequency of null values for nullable fields. If unset, fields will never be null.
Sourcepub fn with_operation_name(self, operation_name: Option<&'doc str>) -> Self
pub fn with_operation_name(self, operation_name: Option<&'doc str>) -> Self
Set the operation name to generate a response for. If unset, uses the anonymous operation.
If the operation does not exist, returns a response with data: null.
Auto Trait Implementations§
impl<'a, 'doc, 'schema> Freeze for ResponseBuilder<'a, 'doc, 'schema>
impl<'a, 'doc, 'schema> !RefUnwindSafe for ResponseBuilder<'a, 'doc, 'schema>
impl<'a, 'doc, 'schema> !Send for ResponseBuilder<'a, 'doc, 'schema>
impl<'a, 'doc, 'schema> !Sync for ResponseBuilder<'a, 'doc, 'schema>
impl<'a, 'doc, 'schema> Unpin for ResponseBuilder<'a, 'doc, 'schema>
impl<'a, 'doc, 'schema> !UnwindSafe for ResponseBuilder<'a, 'doc, 'schema>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);