Struct CredenceConfiguration

pub struct CredenceConfiguration {
    pub definitions: Option<Value>,
    pub files: FilesConfiguration,
    pub ports: BTreeMap<u16, Port>,
    pub requests: RequestsConfiguration,
    pub urls: UrlsConfiguration,
    pub render: RenderConfiguration,
    pub caching: CachingConfiguration,
    pub encoding: EncodingConfiguration,
}

Credence configuration.

Fields

definitions: Option<Value>

Definitions (ignored).

files: FilesConfiguration

Files.

ports: BTreeMap<u16, Port>

Ports.

requests: RequestsConfiguration

Requests.

urls: UrlsConfiguration

URLs.

render: RenderConfiguration

Render.

caching: CachingConfiguration

Caching.

encoding: EncodingConfiguration

Encoding.

Implementations

impl CredenceConfiguration

pub fn read<ReadT>(reader: &mut ReadT) -> Result<Self>

where ReadT: Read,

Resolve.

pub fn validate<PathT>( &mut self, base_path: PathT, ) -> Result<(), ConfigurationError>

where PathT: AsRef<Path>,

Validate.

pub fn caching_layer<RequestBodyT, CacheT>( &self, cache: CacheT, ) -> CachingLayer<RequestBodyT, CacheT, CommonCacheKey>

where CacheT: Cache<CommonCacheKey>,

Caching layer

pub fn hide(&self, uri_path: &str) -> bool

Whether the URI path is hidden.

pub fn rendered_page_uri_path(&self, uri_path: &str) -> Result<Option<String>>

Rendered page URI path.

“{path}” -> “{path}.r.yaml” or “{path}.r.*”

Trait Implementations

impl Clone for CredenceConfiguration

fn clone(&self) -> CredenceConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CredenceConfiguration

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

Formats the value using the given formatter.

impl Debuggable for CredenceConfiguration

fn write_debug_for<WriteT>( &self, writer: &mut WriteT, context: &DebugContext<'_>, ) -> Result<()>

where WriteT: Write,

Write the debug representation for the context.

fn write_debug_with_format<WriteT>( &self, writer: &mut WriteT, format: DebugFormat, ) -> Result<(), Error>

where WriteT: Write,

Write the debug representation with the default theme and a final newline.

fn write_debug<WriteT>(&self, writer: &mut WriteT) -> Result<(), Error>

where WriteT: Write,

Write the debug representation with the default theme and a final newline.

fn write_debug_plain_with_format<WriteT>( &self, writer: &mut WriteT, format: DebugFormat, ) -> Result<(), Error>

where WriteT: Write,

Write the debug representation with the plain theme and a final newline.

fn write_debug_plain<WriteT>(&self, writer: &mut WriteT) -> Result<(), Error>

where WriteT: Write,

Write the debug representation with the plain theme and a final newline.

fn print_debug_with_format(&self, format: DebugFormat)

Print the debug representation to anstream::stdout with the default theme and a final newline.

fn print_debug(&self)

Print the debug representation to anstream::stdout with the default theme and a final newline.

fn print_debug_plain_with_format(&self, format: DebugFormat)

Print the debug representation to stdout with the plain theme and a final newline.

fn print_debug_plain(&self)

Print the debug representation to stdout with the plain theme and a final newline.

fn eprint_debug_with_format(&self, format: DebugFormat)

Print the debug representation to anstream::stderr with the default theme and a final newline.

fn eprint_debug(&self)

Print the debug representation to anstream::stderr with the default theme and a final newline.

fn eprint_debug_plain_with_format(&self, format: DebugFormat)

Print the debug representation to stderr with the plain theme and a final newline.

fn eprint_debug_plain(&self)

Print the debug representation to stderr with the plain theme and a final newline.

fn to_debug_string_with_format( &self, theme: &Theme, format: DebugFormat, ) -> Result<String, Error>

Capture write_debug_for into a string.

fn to_debug_string(&self, theme: &Theme) -> Result<String, Error>

Capture write_debug_for into a string.

impl Default for CredenceConfiguration

fn default() -> Self

Returns the “default value” for a type.

impl<ContextT: ResolveContext, ErrorT: ResolveError> Resolve<CredenceConfiguration, ContextT, ErrorT> for Value

fn resolve_for<'own, ErrorRecipientT>( &'own self, context: Option<&'own ContextT>, ancestor: Option<&'own Value>, errors: &mut ErrorRecipientT, ) -> ResolveResult<CredenceConfiguration, ErrorT>

where ErrorRecipientT: ErrorRecipient<ErrorT>,

Resolve one type into another.

fn resolve_into<ErrorRecipientT>( &self, errors: &mut ErrorRecipientT, ) -> Result<Option<ResolvedT>, ErrorT>

where ErrorRecipientT: ErrorRecipient<ErrorT>,

Resolve one type into another with a provided ErrorRecipient.

fn resolve(&self) -> Result<Option<ResolvedT>, ErrorT>

Resolve one type into another while failing on the first encountered error.