Nancy
Pipeline items to execute
Add an item to the start of the pipeline
Item to add
Add an item to the start of the pipeline
Item to add
Add an item to the start of the pipeline
Item to add
Whether to replace an existing item with the same name in its current place,
rather than at the position requested. Defaults to false.
Add an item to the start of the pipeline
Item to add
Whether to replace an existing item with the same name in its current place,
rather than at the position requested. Defaults to false.
Add an item to the end of the pipeline
Item to add
Add an item to the end of the pipeline
Item to add
Add an item to the end of the pipeline
Item to add
Whether to replace an existing item with the same name in its current place,
rather than at the position requested. Defaults to false.
Add an item to the end of the pipeline
Item to add
Whether to replace an existing item with the same name in its current place,
rather than at the position requested. Defaults to false.
Add an item to a specific place in the pipeline.
Index to add at
Item to add
Add an item to a specific place in the pipeline.
Index to add at
Item to add
Add an item to a specific place in the pipeline.
Index to add at
Item to add
Whether to replace an existing item with the same name in its current place,
rather than at the position requested. Defaults to false.
Add an item to a specific place in the pipeline.
Index to add at
Item to add
Whether to replace an existing item with the same name in its current place,
rather than at the position requested. Defaults to false.
Insert an item before a named item.
If the named item does not exist the item is inserted at the start of the pipeline.
Name of the item to insert before
Item to insert
Insert an item before a named item.
If the named item does not exist the item is inserted at the start of the pipeline.
Name of the item to insert before
Item to insert
Insert an item before a named item.
If the named item does not exist the item is inserted at the start of the pipeline.
Name of the item to insert before
Item to insert
Insert an item before a named item.
If the named item does not exist the item is inserted at the start of the pipeline.
Name of the item to insert before
Item to insert
Insert an item after a named item.
If the named item does not exist the item is inserted at the end of the pipeline.
Name of the item to insert after
Item to insert
Insert an item after a named item.
If the named item does not exist the item is inserted at the end of the pipeline.
Name of the item to insert after
Item to insert
Insert an item after a named item.
If the named item does not exist the item is inserted at the end of the pipeline.
Name of the item to insert after
Item to insert
Insert an item after a named item.
If the named item does not exist the item is inserted at the end of the pipeline.
Name of the item to insert after
Item to insert
Remove a named pipeline item
Name
Index of item that was removed or -1 if nothing removed
Wraps a sync delegate into it's async form
Sync pipeline instance
Async pipeline instance
Gets the current pipeline items
Gets the current pipeline item delegates
Scans the app domain for assemblies and types
Nancy core assembly
App domain type cache
App domain assemblies cache
Indicates whether the all Assemblies, that references a Nancy assembly, have already been loaded
The default assemblies for scanning.
Includes the nancy assembly and anything referencing a nancy assembly
Add assemblies to the list of assemblies to scan for Nancy types
One or more assembly names
Add assemblies to the list of assemblies to scan for Nancy types
One of more assemblies
Add predicates for determining which assemblies to scan for Nancy types
One or more predicates
Load assemblies from a the app domain base directory matching a given wildcard.
Assemblies will only be loaded if they aren't already in the appdomain.
Wildcard to match the assemblies to load
Load assemblies from a given directory matching a given wildcard.
Assemblies will only be loaded if they aren't already in the appdomain.
Directory containing the assemblies
Wildcard to match the assemblies to load
Refreshes the type cache if additional assemblies have been loaded.
Note: This is called automatically if assemblies are loaded using LoadAssemblies.
Updates the assembly cache from the appdomain
Loads any assembly that references a Nancy assembly.
Gets all types implementing a particular interface/base class
Type to search for
An of types.
Will scan with .
Gets all types implementing a particular interface/base class
Type to search for
A value to determine which type set to scan in.
An of types.
Gets all types implementing a particular interface/base class
Type to search for
An of types.
Will scan with .
Gets all types implementing a particular interface/base class
Type to search for
A value to determine which type set to scan in.
An of types.
Returns the directories containing dll files. It uses the default convention as stated by microsoft.
Gets or sets a set of rules for which assemblies are scanned
Defaults to just assemblies that have references to nancy, and nancy
itself.
Each item in the enumerable is a delegate that takes the assembly and
returns true if it is to be included. Returning false doesn't mean it won't
be included as a true from another delegate will take precedence.
Gets app domain types.
Gets app domain types.
Provides a hook to perform registrations during application startup.
Provides a hook to perform registrations during application startup.
Gets the type registrations to register for this startup task
Gets the collection registrations to register for this startup task
Gets the instance registrations to register for this startup task
Provides a hook to execute code during request startup.
Perform any initialisation tasks
Application pipelines
The current context
Helper class for providing application registrations
Scans for the implementation of and registers it.
Lifetime of the registration, defaults to singleton
The to scan for and register as.
Scans for all implementations of and registers them.
Lifetime of the registration, defaults to singleton
The to scan for and register as.
Registers the types provided by the parameters
as .
The to register as.
The types to register.
Lifetime of the registration, defaults to singleton
Registers the type provided by the parameter
as .
Lifetime of the registration, defaults to singleton
The to register as.
The to register as .
Registers an instance as .
The to register as.
The instance to register.
Scans for a that implements . If found, then it
will be used for the registration, else it will use .
Lifetime of the registration, defaults to singleton
The to register as.
The implementation of that will be use if no other implementation can be found.
When scanning, it will exclude the assembly that the instance is defined in and it will also ignore
the type specified by .
Scans for an implementation of and registers it if found. If no implementation could
be found, it will retrieve an instance of using the provided ,
which will be used in the registration.
The to register as.
Factory that provides an instance of .
When scanning, it will exclude the assembly that the instance is defined in
Scans for all implementations of . If no implementations could be found, then it
will register the types specified by .
Lifetime of the registration, defaults to singleton
The to register as.
The types to register if non could be located while scanning.
When scanning, it will exclude the assembly that the instance is defined in and it will also ignore
the types specified by .
Scans for all implementations of and registers them, followed by the
types defined by the parameter.
The to register as.
The types to register last.
Lifetime of the registration, defaults to singleton
When scanning, it will exclude the assembly that the instance is defined in and it will also ignore
the types specified by .
Gets the collection registrations to register for this startup task
Gets the instance registrations to register for this startup task
Gets the type registrations to register for this startup task
Exception that is raised from inside the type or one of
the inheriting types.
Initializes a new instance of the class, with
the provided .
The message that describes the error.
Initializes a new instance of the class, with
the provided and .
The error message that explains the reason for the exception.
The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.
Initializes a new instance of the class.
The that holds the serialized object data about the exception being thrown.
The that contains contextual information about the source or destination.
Represents a type to be registered multiple times into the
container to later be resolved using an IEnumerable{RegistrationType}
constructor dependency.
Base class for container registrations
Checks if all implementation types are assignable from the registration type, otherwise throws an exception.
The implementation types.
One or more of the implementation types is not assignable from the registration type.
The property must be assigned before the method is invoked.
Gets the lifetime of the registration
Registration type i.e. IMyInterface
Represents a type to be registered multiple times into the
container to later be resolved using an IEnumerable{RegistrationType}
constructor dependency.
Registration type i.e. IMyInterface
Collection of implementation type i.e. MyClassThatImplementsIMyInterface
Lifetime to register the type as
Collection of implementation type i.e. MyClassThatImplementsIMyInterface
Application startup task that attempts to locate a favicon. The startup will first scan all
folders in the path defined by the provided and if it cannot
find one, it will fall back and use the default favicon that is embedded in the Nancy.dll file.
Provides a hook to execute code during application startup.
Perform any initialisation tasks
Application pipelines
Initializes a new instance of the class, with the
provided instance.
The that should be used to scan for a favicon.
Perform any initialisation tasks
Application pipelines
Gets the default favicon
A byte array, containing a favicon.ico file.
The pre-request hook
The PreRequest hook is called prior to processing a request. If a hook returns
a non-null response then processing is aborted and the response provided is
returned.
The post-request hook
The post-request hook is called after the response is created. It can be used
to rewrite the response or add/remove items from the context.
The error hook
The error hook is called if an exception is thrown at any time during the pipeline.
If no error hook exists a standard InternalServerError response is returned
Represents an instance to be registered into the container
Initializes a new instance of the class.
The registration type.
The implementation.
Implementation object instance i.e. instance of MyClassThatImplementsIMyInterface
Represents the lifetime of a container registration
Transient lifetime - each request to the container for
the type will result in a new version being returned.
Singleton - each request to the container for the type
will result in the same instance being returned.
PerRequest - within the context of each request each request
for the type will result in the same instance being returned.
Different requests will have different versions.
Exception raised when the discovers more than one
implementation in the loaded assemblies.
Initializes a new instance of the class.
Initializes a new instance of the class.
The message that describes the error.
Initializes a new instance of the class.
The error message that explains the reason for the exception.
The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.
Initializes a new instance of the class.
The provider types.
Initializes a new instance of the class.
The that holds the serialized object data about the exception being thrown.
The that contains contextual information about the source or destination.
Stores the provider types.
The provider types.
Gets the provider types.
The provider types.
Returns a more friendly and informative message if the list of providers is available.
Message generated will be of the format:
More than one IRootPathProvider was found:
Nancy.Tests.Functional.Tests.CustomRootPathProvider2
Nancy.Tests.Functional.Tests.CustomRootPathProvider
and since we do not know which one you want to use, you need to override the RootPathProvider property on your bootstrapper and specify which one to use. Sorry for the inconvenience.
Configuration class for Nancy's internals.
Contains implementation types/configuration for Nancy that usually
do not require overriding in "general use".
Default Nancy configuration with specific overloads
Configuration builder for overriding the default configuration properties.
Nancy configuration instance
Returns the configuration types as a TypeRegistration collection
TypeRegistration collection representing the configuration types
Returns the collection configuration types as a CollectionTypeRegistration collection
CollectionTypeRegistration collection representing the configuration types
Gets the Nancy default configuration
Gets a value indicating whether the configuration is valid.
Default implementation of the Nancy pipelines
Initializes a new instance of the class.
Initializes a new instance of the class and clones the hooks from
the provided instance.
The pre-request hook
The PreRequest hook is called prior to processing a request. If a hook returns
a non-null response then processing is aborted and the response provided is
returned.
The post-request hook
The post-request hook is called after the response is created. It can be used
to rewrite the response or add/remove items from the context.
The error hook
The error hook is called if an exception is thrown at any time during the pipeline.
If no error hook exists a standard InternalServerError response is returned
Determines which set of types that the should scan in.
All available types.
Only in types that are defined in the Nancy assembly.
Only types that are defined outside the Nancy assembly.
Only Namespaces that starts with 'Nancy'
Only Namespaces that does not start with Nancy
Collection of accept header coercions
Built in functions for coercing accept headers.
Adds a default accept header if there isn't one.
Current headers
Context
Modified headers or original if no modification required
Replaces the accept header of stupid browsers that request XML instead
of HTML.
Current headers
Context
Modified headers or original if no modification required
Boosts the priority of HTML for browsers that ask for xml and html with the
same priority.
Current headers
Context
Modified headers or original if no modification required
Built in functions for determining current culture
Checks to see if the Form has a CurrentCulture key.
NancyContext
CultureInfo if found in Form otherwise null
Checks to see if the first argument in the Path can be used to make a CultureInfo.
NancyContext
CultureInfo if found in Path otherwise null
Checks to see if the AcceptLanguage in the Headers can be used to make a CultureInfo. Uses highest weighted if multiple defined.
NancyContext
CultureInfo if found in Headers otherwise null
Checks to see if the Session has a CurrentCulture key
NancyContext
CultureInfo if found in Session otherwise null
Checks to see if the Cookies has a CurrentCulture key
NancyContext
CultureInfo if found in Cookies otherwise null
Uses the Thread.CurrentThread.CurrentCulture
NancyContext
CultureInfo from CurrentThread
Validates culture name
Culture name eg\en-GB
True/False if valid culture
Gets a set of all valid cultures
Collection class for static culture conventions
Creates a new instance of CultureConventions
Wires up the default conventions for the accept header coercion
Provides Nancy convention defaults and validation
Initialise any conventions this class "owns"
Convention object instance
Asserts that the conventions that this class "owns" are valid
Conventions object instance
Tuple containing true/false for valid/invalid, and any error messages
Initialise culture conventions
Determine if culture conventions are valid
Setup default conventions
Defines the default static contents conventions.
Initialise any conventions this class "owns".
Convention object instance.
Asserts that the conventions that this class "owns" are valid
Conventions object instance.
Tuple containing true/false for valid/invalid, and any error messages.
Defines the default static contents conventions.
Initialise any conventions this class "owns".
Convention object instance.
Asserts that the conventions that this class "owns" are valid.
Conventions object instance.
Tuple containing true/false for valid/invalid, and any error messages.
Nancy configurable conventions
Discovered conventions
Initializes a new instance of the class.
Validates the conventions
A tuple containing a flag indicating validity, and any error messages
Gets the instance registrations for registering into the container
Enumeration of InstanceRegistration types
Locates all the default conventions and calls them in
turn to build up the default conventions.
Gets or sets the conventions for locating view templates
Gets or sets the conventions for locating and serving static content
Gets or sets the conventions for coercing accept headers from their source
values to the real values for content negotiation
Gets or sets the conventions for determining request culture
Helper class for defining directory-based conventions for static contents.
Adds a directory-based convention for static convention.
The path that should be matched with the request.
The path to where the content is stored in your application, relative to the root. If this is then it will be the same as .
A list of extensions that is valid for the conventions. If not supplied, all extensions are valid.
A instance for the requested static contents if it was found, otherwise .
Adds a file-based convention for static convention.
The file that should be matched with the request.
The file that should be served when the requested path is matched.
Returns whether the given filename is contained within the content folder
Content root path
Filename requested
True if contained within the content root, false otherwise
Used to uniquely identify a request. Needed for when two Nancy applications want to serve up static content of the same
name from within the same AppDomain.
The path of the static content for which this response is being issued
The root folder path of the Nancy application for which this response will be issued
Nancy static convention helper
Extension method for NancyConventions
conventions.MapStaticContent((File, Directory) =>
{
File["/page.js"] = "page.js";
Directory["/images"] = "images";
});
The conventions to add to.
The callback method allows you to describe the static content
Collection class for static content conventions
Extension methods to adding static content conventions.
Adds a directory-based convention for static convention.
The conventions to add to.
The path that should be matched with the request.
The path to where the content is stored in your application, relative to the root. If this is then it will be the same as .
A list of extensions that is valid for the conventions. If not supplied, all extensions are valid.
Adds a directory-based convention for static convention.
The conventions to add to.
The file that should be matched with the request.
The file that should be served when the requested path is matched.
Nancy static directory convention helper
Creates a new instance of StaticDirectoryContent
NancyConventions, to which static directories get added
Adds a new static directory to the nancy conventions
The route of the file
A list of extensions that is valid for the conventions. If not supplied, all extensions are valid
Nancy static file convention helper
Creates a new instance of StaticFileContent
NancyConventions, to which static files get added
Adds a new static file to the nancy conventions
The route of the file
Determines current culture for context
Provides current culture for Nancy context
Determine current culture for NancyContext
NancyContext
CultureInfo
Creates a new instance of DefaultCultureService
CultureConventions to use for determining culture
Determine current culture for NancyContext
NancyContext
CultureInfo
The default implementation of the interface.
Defines the functionality of a factory.
Creates a new instance.
The instance that should be used by the response formatter.
An instance.
Initializes a new instance of the class, with the
provided .
Creates a new instance.
The instance that should be used by the response formatter.
An instance.
Default implementation of .
Defines the functionality to retrieve the root folder path of the current Nancy application.
Helper interface used to hide the base members from the fluent API to make it much cleaner
in Visual Studio intellisense.
Created by Daniel Cazzulino http://www.clariusconsulting.net/blogs/kzu/archive/2008/03/10/58301.aspx
Hides the method.
Hides the method.
Hides the method.
Hides the method.
Returns the root folder path of the current Nancy application.
A containing the path of the root folder.
Returns the root folder path of the current Nancy application.
A containing the path of the root folder.
The default static content provider that uses
to determine what static content to serve.
Provides static content delivery
Gets the static content response, if possible.
Current context
Response if serving content, null otherwise
Initializes a new instance of the class, using the
provided and .
The current root path provider.
The static content conventions.
Gets the static content response, if possible.
Current context
Response if serving content, null otherwise
Default implementation of the interface.
Defines the functionality for creating an instance.
Creates an instance.
A instance.
An instance.
Creates an instance.
A instance.
An instance.
Default implementation of the interface.
Provides request trace logging.
Uses a delegate to write to the log, rather than creating strings regardless
of whether the log is enabled or not.
Write to the log
Log writing delegate
Creates a new instance of the class.
Write to the log
Log writing delegate
Returns a string that represents the current object.
A string that represents the current object.
Settings for the diagnostics dashboard
Initializes a new instance of the class,
using the cryptographic
configuration.
Initializes a new instance of the class,
using the cryptographic
configuration.
The to use with diagnostics.
Gets or sets the name of the cookie used by the diagnostics dashboard.
The default is __ncd
Gets or sets the cryptography config to use for securing the diagnostics dashboard
Gets or sets password for accessing the diagnostics screen.
This should be secure :-)
Gets or sets the path that the diagnostics dashboard will be accessible on.
The default is /_Nancy. The path should always start with a forward slash.
The number of minutes that expiry of the diagnostics dashboard will be extended each time it is used.
The default is 15 minutes.
Gets a value indicating whether the configuration is valid
Provides a thread safe, limited size, collection of objects
If the collection is full the oldest item gets removed.
Type to store
Creates a new instance of the ConcurrentLimitedCollection class
Maximum size for the collection
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
1
Returns an enumerator that iterates through a collection.
An object that can be used to iterate through the collection.
2
Adds an item to the collection.
If the collection is full, the oldest item is removed and the new item
is added to the end of the collection.
Item to add
Clear the collection
Implementation of the interface that does nothing.
Initialise diagnostics
Application pipelines
Initialise diagnostics
Application pipelines
Defines the functionality for tracing a request.
Gets or sets the generic item store.
An instance containing the items.
Gets or sets the information about the request.
An instance.
Gets or sets the information about the response.
An instance.
Gets the trace log.
A instance.
Implementation of that does not log anything.
Write to the log
Log writing delegate
Returns a string that represents the current object.
A string that represents the current object.
Stores request trace information about the request.
Implicitly casts a instance into a instance.
A instance.
A instance.
Gets or sets the content type of the request.
A containing the content type.
Gets or sets the headers of the request.
A instance containing the headers.
Gets the HTTP verb of the request.
A containing the HTTP verb.
Gets or sets the that was requested.
Stores request trace information about the response.
Implicitly casts a instance into a instance.
A instance.
A instance.
Gets or sets the content type of the response.
A containing the content type.
Gets or sets the headers of the response.
A instance containing the headers.
Gets or sets the of the response.
Gets or sets the of the response.
A instance.
A "disabled" static content provider - always returns null
so no content is served.
Gets the static content response, if possible.
Current context
Response if serving content, null otherwise
Here Be Dragons - Using an exception for flow control to hotwire route execution.
It can be useful to call a method inside a route definition and have that method
immediately return a response (such as for authentication). This exception is used
to allow that flow.
Initializes a new instance of the class.
The response.
The reason for the early exit.
Gets or sets the reason for the early exit
Gets or sets the response
Containing extensions for the property.
Adds a new to the validation results.
A reference to the property.
The name of the property.
The validation error message.
A reference to the property.
Extensions for RequestStream.
Gets the request body as a string.
The request body stream.
The encoding to use, by default.
The request body as a .
Containing extensions for the object.
Buffer size for copy operations
Copies the contents between two instances in an async fashion.
The source stream to copy from.
The destination stream to copy to.
Delegate that should be invoked when the operation has completed. Will pass the source, destination and exception (if one was thrown) to the function. Can pass in .
Containing extensions for the object.
Gets the path of the assembly that contains the provided type.
The to look up the assembly path for.
A string containing the path of the assembly that contains the type.
Checks if a type is an array or not
The type to check.
if the type is an array, otherwise .
Determines whether the is assignable from
taking into account generic definitions
Borrowed from: http://tmont.com/blargh/2011/3/determining-if-an-open-generic-type-isassignablefrom-a-type
Checks if a type is an collection or not
The type to check.
if the type is an collection, otherwise .
Checks if a type is enumerable or not
The type to check.
if the type is an enumerable, otherwise .
Determines if a type is numeric. Nullable numeric types are considered numeric.
Boolean is not considered numeric.
Default implementation of the interface.
Defines the functionality for request tracing.
Adds the , of the provided, to the trace log.
The identifier of the trace.
A instance.
Clears the trace log.
Creates a new trace session.
A which represents the identifier of the new trace session.
Gets all the available instances.
Checks if the provided is valid or not.
A representing the session to check.
if the session is valid, otherwise .
Adds the , of the provided, to the trace log.
The identifier of the trace.
A instance.
Clears the trace log.
Creates a new trace session.
A which represents the identifier of the new trace session.
Gets all the available instances.
Checks if the provided is valid or not.
A representing the session to check.
if the session is valid, otherwise .
Basic class containing the functionality for defining routes and actions in Nancy.
Nancy module base interface
Defines all the properties / behaviour needed by Nancy internally
The post-request hook
The post-request hook is called after the response is created by the route execution.
It can be used to rewrite the response or add/remove items from the context.
The pre-request hook
The PreRequest hook is called prior to executing a route. If any item in the
pre-request pipeline returns a response then the route is not executed and the
response is returned.
The error hook
The error hook is called if an exception is thrown at any time during executing
the PreRequest hook, a route and the PostRequest hook. It can be used to set
the response and/or finish any ongoing tasks (close database session, etc).
Gets or sets the current Nancy context
A instance.
An extension point for adding support for formatting response contents.
This property will always return because it acts as an extension point.Extension methods to this property should always return or one of the types that can implicitly be types into a .
Gets or sets the model binder locator
Gets or sets the model validation result
Gets or sets the validator locator.
Gets or sets an instance that represents the current request.
An instance.
The extension point for accessing the view engines in Nancy.
An instance.This is automatically set by Nancy at runtime.
Get the root path of the routes in the current module.
A containing the root path of the module or if no root path should be used.All routes will be relative to this root path.
Gets all declared routes by the module.
A instance, containing all instances declared by the module.
Gets or sets the dynamic object used to locate text resources.
Renders a view from inside a route handler.
A instance that is used to determine which view that should be rendered.
Used to negotiate the content returned based on Accepts header.
A instance that is used to negotiate the content returned.
Initializes a new instance of the class.
Initializes a new instance of the class.
A containing the root relative path that all paths in the module will be a subset of.
Non-model specific data for rendering in the response
Gets for declaring actions for DELETE requests.
A instance.
Gets for declaring actions for GET requests.
A instance.
Gets for declaring actions for HEAD requests.
A instance.
Gets for declaring actions for OPTIONS requests.
A instance.
Gets for declaring actions for PATCH requests.
A instance.
Gets for declaring actions for POST requests.
A instance.
Gets for declaring actions for PUT requests.
A instance.
Get the root path of the routes in the current module.
A containing the root path of the module or
if no root path should be used.All routes will be relative to this root path.
Gets all declared routes by the module.
A instance, containing all instances declared by the module.
This is automatically set by Nancy at runtime.
Gets the current session.
Renders a view from inside a route handler.
A instance that is used to determine which view that should be rendered.
Used to negotiate the content returned based on Accepts header.
A instance that is used to negotiate the content returned.
Gets or sets the validator locator.
This is automatically set by Nancy at runtime.
Gets or sets an instance that represents the current request.
An instance.
The extension point for accessing the view engines in Nancy.
An instance.
This is automatically set by Nancy at runtime.
The post-request hook
The post-request hook is called after the response is created by the route execution.
It can be used to rewrite the response or add/remove items from the context.
This is automatically set by Nancy at runtime.
The pre-request hook
The PreRequest hook is called prior to executing a route. If any item in the
pre-request pipeline returns a response then the route is not executed and the
response is returned.
This is automatically set by Nancy at runtime.
The error hook
The error hook is called if an exception is thrown at any time during executing
the PreRequest hook, a route and the PostRequest hook. It can be used to set
the response and/or finish any ongoing tasks (close database session, etc).
This is automatically set by Nancy at runtime.
Gets or sets the current Nancy context
A instance.
This is automatically set by Nancy at runtime.
An extension point for adding support for formatting response contents.
This property will always return because it acts as an extension point.Extension methods to this property should always return or one of the types that can implicitly be types into a .
Gets or sets the model binder locator
This is automatically set by Nancy at runtime.
Gets or sets the model validation result
This is automatically set by Nancy at runtime when you run validation.
Helper class for configuring a route handler in a module.
Initializes a new instance of the class.
The HTTP request method that the route should be available for.
The that the route is being configured for.
Defines a Nancy route for the specified .
A delegate that is used to invoke the route.
Defines a Nancy route for the specified and .
A delegate that is used to invoke the route.
Defines an async route for the specified
Defines an async route for the specified and .
Defines a Nancy route for the specified and
A delegate that is used to invoke the route.
Defines a Nancy route for the specified , and
A delegate that is used to invoke the route.
Defines an async route for the specified and
Defines an async route for the specified , and
Defines the functionality to build a fully configured NancyModule instance.
Builds a fully configured instance, based upon the provided .
The that should be configured.
The current request context.
A fully configured instance.
Builds a fully configured instance, based upon the provided .
The that should be configured.
The current request context.
A fully configured instance.
Catalog of instances.
Get all NancyModule implementation instances - should be per-request lifetime
The current context
An instance containing instances.
Retrieves a specific implementation - should be per-request lifetime
Module type
The current context
The instance
Get all NancyModule implementation instances - should be per-request lifetime
The current context
An instance containing instances.
Retrieves a specific implementation - should be per-request lifetime
Module type
The current context
The instance
Wires up the diagnostics support at application startup.
Creates a new instance of the class.
Initialise diagnostics
Application pipelines
Renders diagnostics views from embedded resources.
Creates a new instance of the class.
A instance.
Renders the diagnostics view with the provided .
The name of the view to render.
A of the rendered view.
Renders the diagnostics view with the provided and .
The name of the view to render.
The model that should be passed to the view engine during rendering.
A of the rendered view.
Defines the functionality for resolving the requested view.
Locates a view based on the provided information.
The name of the view to locate.
The model that will be used with the view.
A instance, containing information about the context for which the view is being located.
A instance if the view could be found, otherwise .
Locates a view based on the provided information.
The name of the view to locate.
The model that will be used with the view.
A instance, containing information about the context for which the view is being located.
A instance if the view could be found, otherwise .
Used to return string values
Gets a translation based on the provided key.
The key to look up the translation for.
The current instance.
Helper class for caching related functions
Returns whether to return a not modified response, based on the etag and last modified date
of the resource, and the current nancy context
Current resource etag, or null
Current resource last modified, or null
Current nancy context
True if not modified should be sent, false otherwise
Add this attribute to an assembly to make sure
it is included in Nancy's assembly scanning.
Apply the attribute, typically in AssemblyInfo.(cs|fs|vb), as follows:
[assembly: IncludeInNancyAssemblyScanning]
Returns text from an implemented ITextResource
Initializes a new instance of the class.
The that should be used by the TextResourceFinder
The that should be used by the TextResourceFinder
Finds text resource
GetMemberBinder with dynamic text key
Text item
Returns a value or a non existing value from the implementation
Gets the that is being used to locate texts.
An instance.
Gets a translation based on the provided key.
The key to look up the translation for.
Configurations that controls the behavior of the binder at runtime.
Initializes a new instance of the class.
Binding configuration that permits that the binder overwrites non-default values.
Default binding configuration.
Gets or sets whether the binder should be happy once it has bound to the request body. In this case,
request and context parameters will not be bound to. If there is no body and this option is enabled,
no binding will take place at all.
if the binder will stop once the body has been bound, otherwise .
Gets or sets whether binding error should be ignored and the binder should continue with the next property.
Setting this property to means that no will be thrown if an error occurs.
If the binder should ignore errors, otherwise .
Gets or sets whether the binder is allowed to overwrite properties that does not have a default value.
if the binder is allowed to overwrite non-default values, otherwise .
Represents a bindable member of a type, which can be a property or a field.
Constructs a BindingMemberInfo instance for a property.
The bindable property to represent.
Constructs a BindingMemberInfo instance for a field.
The bindable field to represent.
Gets the value from a specified object associated with the property or field represented by this BindingMemberInfo.
The object whose property or field should be retrieved.
The value for this BindingMemberInfo's property or field in the specified object.
Sets the value from a specified object associated with the property or field represented by this BindingMemberInfo.
The object whose property or field should be assigned.
The value to assign in the specified object to this BindingMemberInfo's property or field.
Compares two BindingMemberInfo's with eachother on their respective values rather then their reference
the other BindingMemberInfo
true when they are equal and false otherwise
Returns an enumerable sequence of bindable properties for the specified type.
The type to enumerate.
Bindable properties.
Returns an enumerable sequence of bindable properties for the specified type.
The type to enumerate.
Bindable properties.
Gets a reference to the MemberInfo that this BindingMemberInfo represents. This can be a property or a field.
Gets the name of the property or field represented by this BindingMemberInfo.
Gets the data type of the property or field represented by this BindingMemberInfo.
Converter for datetime types
Provides a way to convert from the incoming string representation
of a type to the type itself.
Whether the converter can convert to the destination type
Destination type
The current binding context
True if conversion supported, false otherwise
Convert the string representation to the destination type
Input string
Destination type
Current context
Converted object of the destination type
Whether the converter can convert to the destination type
Destination type
The current binding context
True if conversion supported, false otherwise
Convert the string representation to the destination type
Input string
Destination type
Current context
Converted object of the destination type
Converter for numeric types
Whether the converter can convert to the destination type
Destination type
The current binding context
True if conversion supported, false otherwise
Convert the string representation to the destination type
Input string
Destination type
Current context
Converted object of the destination type
Contains extension methods for the type.
Retrieves the member that an expression is defined for.
The expression to retrieve the member from.
A instance if the member could be found; otherwise .
Creates new instance
the name of the property which failed to bind
the value attempted to set
the underlying exception
Gets the property name for which the bind failed
Gets the value which was attempted to be assigned to the property
Handles an incoming .
The instance.
An instance, containing the information about the current request.
A instance containing the request/response context.
Handles an incoming .
The instance.
An instance, containing the information about the current request.
Delegate to call before the request is processed
A instance containing the request/response context.
Handles an incoming async.
The instance.
An instance, containing the information about the current request.
Delegate to call before the request is processed
Delegate to call when the request is complete
Delegate to call when any errors occur
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Handles an incoming async.
The instance.
An instance, containing the information about the current request.
Delegate to call when the request is complete
Delegate to call when any errors occur
Add a cookie to the response.
The instance.
The instance that should be added.
The modified instance.
Add a collection of cookies to the response.
The instance.
The instances that should be added.
The modified instance.
Add a header to the response
Negotiator object
Header name
Header value
Modified negotiator
Add a content type to the response
Negotiator object
Content type value
Modified negotiator
Adds headers to the response using anonymous types
Negotiator object
Array of headers - each header should be an anonymous type with two string properties
'Header' and 'Value' to represent the header name and its value.
Modified negotiator
Adds headers to the response using anonymous types
Negotiator object
Array of headers - each header should be a Tuple with two string elements
for header name and header value
Modified negotiator
Allows the response to be negotiated with any processors available for any content type
Negotiator object
Modified negotiator
Allows the response to be negotiated with a specific media range
This will remove the wildcard range if it is already specified
Negotiator object
Media range to add
Modified negotiator
Uses the specified model as the default model for negotiation
Negotiator object
Model object
Modified negotiator
Uses the specified view for html output
Negotiator object
View name
Modified negotiator
Sets the model to use for a particular media range.
Will also add the MediaRange to the allowed list
Negotiator object
Range to match against
Model object
Updated negotiator object
Sets the model to use for a particular media range.
Will also add the MediaRange to the allowed list
Negotiator object
Range to match against
Model factory for returning the model object
Updated negotiator object
Sets the to use for a particular media range.
Will also add the MediaRange to the allowed list
Negotiator object
Range to match against
A object
Updated negotiator object
Sets the to use for a particular media range.
Will also add the MediaRange to the allowed list
Negotiator object
Range to match against
Factory for returning the object
Updated negotiator object
Sets the status code that should be assigned to the final response.
Negotiator object
The status code that should be used.
Updated negotiator object
Sets the description of the status code that should be assigned to the final response.
Negotiator object
The status code description that should be used.
Updated negotiator object
Sets the status code that should be assigned to the final response.
Negotiator object
The status code that should be used.
Updated negotiator object
OWIN extensions for the delegate-based approach.
Adds Nancy to the OWIN pipeline.
The application builder delegate.
A configuration builder action.
The application builder delegate.
Adds Nancy to the OWIN pipeline.
The application builder delegate.
The Nancy options.
The application builder delegate.
OWIN extensions for the NancyContext.
Gets the OWIN environment dictionary.
The Nancy context.
The OWIN environment dictionary.
Options for hosting Nancy with OWIN.
Gets or sets the bootstrapper. If none is set, NancyBootstrapperLocator.Bootstrapper is used.
Gets or sets the delegate that determines if NancyMiddleware performs pass through.
Gets or sets a value indicating whether to request a client certificate or not.
Defaults to false.
Extensions for the NancyOptions class.
Tells the NancyMiddleware to pass through when
response has one of the given status codes.
The Nancy options.
The HTTP status code.
Nancy middleware for OWIN.
The request environment key
Use Nancy in an OWIN pipeline
A delegate to configure the .
An OWIN middleware delegate.
Use Nancy in an OWIN pipeline
An to configure the Nancy middleware
An OWIN middleware delegate.
Gets a delegate to handle converting a nancy response
to the format required by OWIN and signals that the we are
now complete.
OWIN environment.
The next stage in the OWIN pipeline.
The task completion source to signal.
A predicate that will allow the caller to determine if the request passes through to the
next stage in the owin pipeline.
Delegate
Gets a delegate to handle request errors
Completion source to signal
Delegate
Creates the Nancy URL
OWIN Hostname
OWIN Scheme
OWIN Base path
OWIN Path
OWIN Querystring
Gets a delegate to store the OWIN environment into the NancyContext
OWIN Environment
Delegate
Encapsulates HTTP-response information from an Nancy operation.
Null object representing no body
Initializes a new instance of the class.
Executes at the end of the nancy execution pipeline and before control is passed back to the hosting.
Can be used to pre-render/validate views while still inside the main pipeline/error handling.
Nancy context
Task for completion/erroring
Adds a to the response.
The name of the cookie.
The value of the cookie.
The instance.
Adds a to the response.
The name of the cookie.
The value of the cookie.
The expiration date of the cookie. Can be if it should expire at the end of the session.
The instance.
Adds a to the response.
The name of the cookie.
The value of the cookie.
The expiration date of the cookie. Can be if it should expire at the end of the session.
The domain of the cookie.
The path of the cookie.
The instance.
Adds a to the response.
A instance.
Implicitly cast an value to a instance, with the
set to the value of the .
The value that is being cast from.
A instance.
Implicitly cast an int value to a instance, with the
set to the value of the int.
The int value that is being cast from.
A instance.
Implicitly cast an string instance to a instance, with the
set to the value of the string.
The string that is being cast from.
A instance.
Implicitly cast an , where T is a , instance to
a instance, with the set to the value of the action.
The instance that is being cast from.
A instance.
Implicitly cast a instance to a instance,
with the set to the value of the .
The instance that is being cast from.
A instance.
Converts a string content value to a response action.
The string containing the content.
A response action that will write the content of the string to the response stream.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
This method can be overridden in sub-classes to dispose of response specific resources.
Gets or sets the type of the content.
The type of the content.
The default value is text/html.
Gets the delegate that will render contents to the response stream.
An delegate, containing the code that will render contents to the response stream.
The host of Nancy will pass in the output stream after the response has been handed back to it by Nancy.
Gets the collection of HTTP response headers that should be sent back to the client.
An instance, containing the key/value pair of headers.
Gets or sets the HTTP status code that should be sent back to the client.
A value.
Gets or sets a text description of the HTTP status code returned to the client.
The HTTP status code description.
Gets the instances that are associated with the response.
A instance, containing instances.
Defines the functionality a diagnostics provider.
Gets the name of the provider.
A containing the name of the provider.
Gets the description of the provider.
A containing the description of the provider.
Gets the object that contains the interactive diagnostics methods.
An instance of the interactive diagnostics object.
Gets the name of the provider.
A containing the name of the provider.
Gets the description of the provider.
A containing the description of the provider.
Gets the object that contains the interactive diagnostics methods.
An instance of the interactive diagnostics object.
Enable JSONP support in the application
Application Pipeline to Hook into
Disable JSONP support in the application
Application Pipeline to Hook into
Transmogrify original response and apply JSONP Padding
Current Nancy Context
Enables JSONP support at application startup.
Perform any initialisation tasks
Application pipelines
Exception that is thrown when an unhandled exception occurred during
the execution of the current request.
Initializes a new instance of the , with
the specified .
Takes an existing response and materialises the body.
Can be used as a wrapper to force execution of the deferred body for
error checking etc.
Copies the existing response into memory, so use with caution.
Response that indicates that the response format should be negotiated between the client and the server.
Initializes a new instance of the response for the
provided .
The response value that should be negotiated.
Gets or sets the value that should be negotiated.
The default implementation for a response negotiator.
Creates a response from a given result and context.
Negotiates the response based on the given result and context.
The route result.
The context.
A .
Initializes a new instance of the class.
The response processors.
The Accept header coercion conventions.
Negotiates the response based on the given result and context.
The route result.
The context.
A .
Tries to cast the dynamic result to a .
The result.
The response.
true if the result is a , false otherwise.
Gets a based on the given result and context.
The route result.
The context.
A .
Gets the coerced accept headers based on the .
The context.
IEnumerable{Tuple{System.String, System.Decimal}}.
Gets compatible response processors by header.
The accept header.
The model.
The context.
IEnumerable{Tuple{IResponseProcessor, ProcessorMatch}}.
Creates a response from the compatible headers.
The compatible headers.
The negotiation context.
The context.
A .
Prioritizes the response processors and tries to negotiate a response.
The compatible headers.
The negotiation context.
The context.
Response.
Adds a link header to the .
The compatible headers.
The response.
The request URL.
Gets the link processors based on the compatible headers and content-type.
The compatible headers.
The content-type of the response.
Dictionary{System.String, MediaRange}.
Creates the link header with the different media ranges.
The request URL.
The link processors.
The link header.
Adds the content type header from the to the .
The negotiation context.
The response.
Adds the negotiated headers from the to the .
The negotiation context.
The response.
Sets the status code from the on the .
The negotiation context.
The response.
Sets the reason phrase from the on the .
The negotiation context.
The response.
Adds the cookies from the to the .
The negotiation context.
The response.
Content negotiation response processor
Determines whether the processor can handle a given content type and model.
Content type requested by the client.
The model for the given media range.
The nancy context.
A result that determines the priority of the processor.
Process the response.
Content type requested by the client.
The model for the given media range.
The nancy context.
A instance.
Gets a set of mappings that map a given extension (such as .json)
to a media range that can be sent to the client in a vary header.
Processes the model for json media types and extension.
Initializes a new instance of the class,
with the provided .
The serializes that the processor will use to process the request.
Determines whether the processor can handle a given content type and model
Content type requested by the client
The model for the given media range
The nancy context
A ProcessorMatch result that determines the priority of the processor
Process the response
Content type requested by the client
The model for the given media range
The nancy context
A response
Gets a set of mappings that map a given extension (such as .json)
to a media range that can be sent to the client in a vary header.
Represents whether a processor has matched/can handle processing the response.
Values are of increasing priority.
No match, nothing to see here, move along
Will accept anything
Matched, but in a non-specific way such as a wildcard match or fallback
Exact specific match
Represents a media range from an accept header
Initializes a new instance of the class from a string representation of a media range
the content type
Initializes a new instance of the class.
Whether or not a media range matches another, taking into account wildcards
Other media range
True if matching, false if not
Whether or not a media range matches another, taking into account wildcards and parameters
Other media range
True if matching, false if not
Creates a MediaRange from a "Type/SubType" string
Media range type
Media range subtype
Media range parameters
Gets a value indicating if the media range is the */* wildcard
Provides strongly-typed access to media range parameters.
Initializes a new instance of the class.
Initializes a new instance of the class.
The parameters.
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
Whether or not a set of media range parameters matches another, regardless of order
Other media range parameters
True if matching, false if not
Returns an enumerator that iterates through a collection.
An object that can be used to iterate through the collection.
Creates a MediaRangeParameters collection from a "a=1,b=2" string
Gets the names of the available parameters.
An containing the names of the parameters.
Gets all the parameters values.
An that contains all the parameters values.
Gets the value for the parameter identified by the parameter.
The name of the parameter to return the value for.
The value for the parameter. If the parameter is not defined then null is returned.
Represents a media type or subtype in a .
Initializes a new instance of the class for the media type part.
Matched the media type with another media type.
The media type that should be matched against.
if the media types match, otherwise .
Gets a value indicating whether the media type is a wildcard or not
if the media type is a wildcard, otherwise .
Context for content negotiation.
Initializes a new instance of the class.
Gets the correct model for the given media range
The to get the model for.
The model for the provided if it has been mapped, otherwise the will be returned.
Gets or sets additional cookies to assign to the response.
An of instances.
Gets or sets the default model that will be used if a content type specific model is not specified.
The default model instance.
Gets or sets the additional response headers required.
An containing the headers.
Gets or sets the model mappings for media ranges.
An containing the media range model mappings.
The name of the that is locating a view.
A containing the name of the module.
The module path of the that is locating a view.
A containing the module path.
Gets or sets allowed media ranges.
A list of the allowed media ranges.
Gets or sets the status code of the response.
A value.
Gets or sets a text description of the HTTP status code returned to the client.
The HTTP status code description.
Gets or sets the view name if one is required.
The name of the view that should be rendered.
Initializes a new instance of the class,
with the provided .
The context that should be negotiated.
Gets the used by the negotiator.
A instance.
Represents whether a processor has matched / can handle a requested response
A with both and set to .
Gets or sets the match result based on the content type
Gets or sets the match result based on the model
Processes negotiated responses of model type .
Determines whether the processor can handle a given content type and model.
Content type requested by the client.
The model for the given media range.
The nancy context.
A result that determines the priority of the processor.
Process the response.
Content type requested by the client.
The model for the given media range.
The nancy context.
A instance.
Gets a set of mappings that map a given extension (such as .json)
to a media range that can be sent to the client in a vary header.
Processes the model for view requests.
Initializes a new instance of the class,
with the provided .
The view factory that should be used to render views.
Determines whether the processor can handle a given content type and model.
Content type requested by the client.
The model for the given media range.
The nancy context.
A result that determines the priority of the processor.
Process the response.
Content type requested by the client.
The model for the given media range.
The nancy context.
A instance.
Gets a set of mappings that map a given extension (such as .json)
to a media range that can be sent to the client in a vary header.
Processes the model for xml media types and extension.
Initializes a new instance of the class,
with the provided .
The serializes that the processor will use to process the request.
Determines whether the processor can handle a given content type and model.
Content type requested by the client.
The model for the given media range.
The nancy context.
A result that determines the priority of the processor.
Process the response.
Content type requested by the client.
The model for the given media range.
The nancy context.
A instance.
Gets a set of mappings that map a given extension (such as .json)
to a media range that can be sent to the client in a vary header.
Response with status code 406 (Not Acceptable).
Initializes a new instance of the class.
Response that returns the contents of a stream of a given content-type.
Initializes a new instance of the class with the
provided stream provider and content-type.
The value producer for the response.
The content-type of the stream contents.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
To close the unclosable stream..
To fight the unbeatable foe..
To bear with unbearable sorrow..
To run where the brave dare not go..
The wrapped stream
Initializes a new instance of the class.
The base stream to wrap.
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
1
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
2
When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
An I/O error occurs. 2
When overridden in a derived class, sets the position within the current stream.
The new position within the current stream.
A byte offset relative to the parameter. A value of type indicating the reference point used to obtain the new position. An I/O error occurs. The stream does not support seeking, such as if the stream is constructed from a pipe or console output. Methods were called after the stream was closed. 1
When overridden in a derived class, sets the length of the current stream.
The desired length of the current stream in bytes. An I/O error occurs. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. Methods were called after the stream was closed. 2
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source. The zero-based byte offset in at which to begin storing the data read from the current stream. The maximum number of bytes to be read from the current stream. The sum of and is larger than the buffer length. is null. or is negative. An I/O error occurs. The stream does not support reading. Methods were called after the stream was closed. 1
When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
An array of bytes. This method copies bytes from to the current stream. The zero-based byte offset in at which to begin copying bytes to the current stream. The number of bytes to be written to the current stream. The sum of and is greater than the buffer length. is null. or is negative. An I/O error occurs. The stream does not support writing. Methods were called after the stream was closed. 1
Begins an asynchronous read operation.
An that represents the asynchronous read, which could still be pending.
The buffer to read the data into. The byte offset in at which to begin writing data read from the stream. The maximum number of bytes to read. An optional asynchronous callback, to be called when the read is complete. A user-provided object that distinguishes this particular asynchronous read request from other requests. Attempted an asynchronous read past the end of the stream, or a disk error occurs. One or more of the arguments is invalid. Methods were called after the stream was closed. The current Stream implementation does not support the read operation. 2
Begins an asynchronous write operation.
An IAsyncResult that represents the asynchronous write, which could still be pending.
The buffer to write data from. The byte offset in from which to begin writing. The maximum number of bytes to write. An optional asynchronous callback, to be called when the write is complete. A user-provided object that distinguishes this particular asynchronous write request from other requests. Attempted an asynchronous write past the end of the stream, or a disk error occurs. One or more of the arguments is invalid. Methods were called after the stream was closed. The current Stream implementation does not support the write operation. 2
Waits for the pending asynchronous read to complete.
The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available.
The reference to the pending asynchronous request to finish. is null. did not originate from a method on the current stream. The stream is closed or an internal error has occurred.2
Ends an asynchronous write operation.
A reference to the outstanding asynchronous I/O request. is null. did not originate from a method on the current stream. The stream is closed or an internal error has occurred.2
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
The unsigned byte cast to an Int32, or -1 if at the end of the stream.
The stream does not support reading. Methods were called after the stream was closed. 2
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
The byte to write to the stream. An I/O error occurs. The stream does not support writing, or the stream is already closed. Methods were called after the stream was closed. 2
Releases the unmanaged resources used by the and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets the base stream that the wrapper is wrapping
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
true if the stream supports reading; otherwise, false.
1
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
true if the stream supports seeking; otherwise, false.
1
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
true if the stream supports writing; otherwise, false.
1
When overridden in a derived class, gets the length in bytes of the stream.
A long value representing the length of the stream in bytes.
A class derived from Stream does not support seeking. Methods were called after the stream was closed. 1
When overridden in a derived class, gets or sets the position within the current stream.
The current position within the stream.
An I/O error occurs. The stream does not support seeking. Methods were called after the stream was closed. 1
Gets a value that determines whether the current stream can time out.
A value that determines whether the current stream can time out.
2
Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
A value, in milliseconds, that determines how long the stream will attempt to read before timing out.
The method always throws an . 2
Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
A value, in milliseconds, that determines how long the stream will attempt to write before timing out.
The method always throws an . 2
Whether the serializer can serialize the content type
Content type to serialise
True if supported, false otherwise
Serialize the given model with the given contentType
Content type to serialize into
Model to serialize
Output stream to serialize to
Serialised object
Gets the list of extensions that the serializer can handle.
An of extensions if any are available, otherwise an empty enumerable.
JSON serializer settings
Max length of JSON output
Maximum number of recursions
Default charset for JSON responses.
Gets the default encoding for JSON responses.
The default value is
Set to true to retain the casing used in the C# code in produced JSON.
Set to false to use camelCasing in the produced JSON.
False by default.
Serialized date format
Whether the serializer can serialize the content type
Content type to serialise
True if supported, false otherwise
Serialize the given model with the given contentType
Content type to serialize into
Model to serialize
Stream to serialize to
Serialised object
Attempts to detect if the content type is JSON.
Supports:
application/json
text/json
application/vnd[something]+json
Matches are case insentitive to try and be as "accepting" as possible.
Request content type
True if content type is JSON, false otherwise
Gets the list of extensions that the serializer can handle.
An of extensions if any are available, otherwise an empty enumerable.
Set to true to retain the casing used in the C# code in produced JSON.
Set to false to use camelCasig in the produced JSON.
False by default.
Set to true to use the ISO8601 format for datetimes in produced JSON.
Set to false to use the WCF \/Date()\/ format in the produced JSON.
True by default.
Whether the serializer can serialize the content type
Content type to serialise
True if supported, false otherwise
Serialize the given model with the given contentType
Content type to serialize into
Model to serialize
Output stream to serialize to
Serialised object
Gets the list of extensions that the serializer can handle.
An of extensions if any are available, otherwise an empty enumerable.
Represents a text (text/plain) response
Creates a new instance of the TextResponse class
Text content - defaults to empty if null
Content Type - defaults to text/plain
String encoding - UTF8 if null
Creates a new instance of the TextResponse class
Status code - defaults to OK
Text content - defaults to empty if null
String encoding - UTF8 if null
Headers if required
Cookies if required
Constraint for alphabetical route segments.
Convenience class for implementing a route segment constraint.
The type of parameter to capture.
Defines the functionality to constrain route matching.
Determines whether the given constraint should be matched.
The route constraint.
true if the constraint matches, false otherwise.
Matches the segment and parameter name against the constraint.
The constraint.
The segment.
Name of the parameter.
A containing information about the captured parameters.
Tries to match the given segment against the constraint.
The constraint.
The segment to match.
The matched value.
true if the segment matches the constraint, false otherwise.
Gets the name of the constraint, i.e. "int".
The constraint's name.
Constraint for route segments.
Constraint for route segments with custom format.
Convenience class for implementing a route segment constraint that expects parameters.
The type of parameter to capture.
Tries to parse an integer using .
The string value.
The resulting integer.
true if the parsing was successful, false otherwise.
Tries to match the given segment and parameters against the constraint.
The segment to match.
The parameters to match.
The matched value.
true if the segment and parameters matches the constraint, false otherwise.
Constraint for route segments.
Constraint for route segments.
Constraint for route segments.
Constraint for route segments.
Constraint for route segments.
Constraint for route segments with a specific length.
Constraint for route segments with a maximum length.
Constraint for route segments with a maximum value.
Constraint for route segments with a minimum length.
Constraint for route segments with a minimum length.
Constraint for route segments with value within a specified range.
Constraint for version route segments.
Default implementation of a request dispatcher.
Functionality for processing an incoming request.
Dispatches a requests.
The for the current request.
Cancellation token
Initializes a new instance of the class, with
the provided , and .
Dispatches a requests.
The for the current request.
Default implementation of the interface. Will look for
route descriptions in resource files. The resource files should have the same name as the module
for which it defines routes.
Defines the functionality for retrieving a description for a specific route.
Get the description for a route.
The module that the route is defined in.
The path of the route that the description should be retrieved for.
A containing the description of the route if it could be found, otherwise .
Get the description for a route.
The module that the route is defined in.
The path of the route that the description should be retrieved for.
A containing the description of the route if it could be found, otherwise .
Default route invoker implementation.
Defines the functionality for invoking a and returning a
Invokes the specified with the provided .
The route that should be invoked.
Cancellation token
The parameters that the route should be invoked with.
The context of the route that is being invoked.
A instance that represents the result of the invoked route.
Initializes a new instance of the class.
The response negotiator.
Invokes the specified with the provided .
The route that should be invoked.
Cancellation token
The parameters that the route should be invoked with.
The context of the route that is being invoked.
A instance that represents the result of the invoked route.
Default implementation of the interface.
Defines the functionality for extracting the individual segments from a route path.
Extracts the segments from the ;
The path that the segments should be extracted from.
An , containing the extracted segments.
Extracts the segments from the ;
The path that the segments should be extracted from.
An , containing the extracted segments.
Defines the functionality for retrieving metadata for routes.
Gets the of the metadata that is created by the provider.
The instance that the route is declared in.
A for the route.
A instance, or if nothing is found.
Gets the metadata for the provided route.
The instance that the route is declared in.
A for the route.
An object representing the metadata for the given route, or if nothing is found.
Information about a segment parameter.
Initializes a new instance of the class.
The name of the parameter
The default value, if any, of the parameter.
if the parameter is optional, otherwise .
Gets the default value for the parameter.
Gets the full name of the segment.
Returns a string in one of the formats: {name}, {name?}, {name?defaultValue} depending on the kind of parameter.
Gets whether or not the parameter is optional.
if the parameter is optional, otherwise .
Gets the name of the parameter.
A class representing a route resolution result
Gets or sets the route
Gets or sets the captured parameters
Gets or sets the before module pipeline
Gets or sets the after module pipeline
Gets or sets the on error module pipeline
Route that is returned when the path could be matched but, the method was OPTIONS and there was no user defined handler for OPTIONS.
Stores information about a declared route in Nancy.
Initializes a new instance of the type, with the specified .
The action that should take place when the route is invoked.
Initializes a new instance of the type, with the specified definition.
Route name
The HTTP method that the route is declared for.
The path that the route is declared for.
A condition that needs to be satisfied inorder for the route to be eligible for invocation.
The action that should take place when the route is invoked.
Initializes a new instance of the type, with the specified definition.
The HTTP method that the route is declared for.
The path that the route is declared for.
A condition that needs to be satisfied inorder for the route to be eligiable for invocation.
The action that should take place when the route is invoked.
Invokes the route with the provided .
A that contains the parameters that should be passed to the route.
Cancellation token
A (hot) task of instance.
Creates a route from a sync delegate signature
The action that should take place when the route is invoked.
A Route instance
Creates a route from a sync delegate signature
The HTTP method that the route is declared for.
The path that the route is declared for.
A condition that needs to be satisfied inorder for the route to be eligiable for invocation.
The action that should take place when the route is invoked.
A Route instance
Creates a route from a sync delegate signature
Route name
The HTTP method that the route is declared for.
The path that the route is declared for.
A condition that needs to be satisfied inorder for the route to be eligible for invocation.
The action that should take place when the route is invoked.
A Route instance
Wraps a sync delegate in a delegate that returns a task
Sync delegate
Task wrapped version
Gets or sets the action that should take place when the route is invoked.
A that represents the action of the route.
Gets the description of the route.
A instance.
Contains extensions for the type.
Retrieves metadata for all declared routes.
The type of the metadata to retrieve.
The to retrieve the metadata.
An containing instances of the type.
Stores metadata created by instances.
Creates a new instance of the class.
An containing the metadata, organised by the type that it is stored in.
Gets a boolean that indicates if the specific type of metadata is stored.
The type of the metadata to check for.
if metadata, of the requested type is stored, otherwise .
Retrieves metadata of the provided type.
The type of the metadata to retrieve.
The metadata instance if available, otherwise .
Gets the raw metadata .
An instance.
Defines the functionality for retrieving metadata for routes.
The metadata type.
Gets the of the metadata that is created by the provider.
The instance that the route is declared in.
A for the route.
A instance, or null if none are found.
Gets the metadata for the provided route.
The instance that the route is declared in.
A for the route.
An instance of .
Gets the metadata for the provided route.
The instance that the route is declared in.
A for the route.
An instance of .
Trie structure for resolving routes
Build the trie from the route cache
The route cache
Get all matches for the given method and path
HTTP method
Requested path
Current Nancy context
An array of elements
Get all method options for the given path
Requested path
Current Nancy context
A collection of strings, each representing an allowed method
Factory for creating trie nodes from route definition segments
Gets the correct Trie node type for the given segment
Parent node
Segment
Corresponding TrieNode instance
Match result for a matched route
Represents a route that ends at a particular node.
We store/calculate as much as we can at build time to save
time during route matching.
Gets or sets the module type from the matching module
Gets or sets the route method
Gets or sets the index in the module routing table
Gets or sets the number of segments in the route
Gets or sets the route score
Gets or sets the route condition delegate
Compares the current object with another object of the same type.
A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than .
An object to compare with this object.
Gets or sets the captured parameters
Gets the "no match"
Gets the "no matches" collection
Helpers methods for NodeData
Converts a instance into a
Node data
Captured parameters
A instance
A node for standard captures e.g. {foo}
A base class representing a node in the route trie
Initializes a new instance of the class
Parent node
Segment of the route definition
Factory for creating new nodes
Add a new route to the trie
The segments of the route definition
The module key the route comes from
The route index in the module
The route description
Add a new route to the trie
The segments of the route definition
Current index in the segments array
Current score for this route
Number of nodes added for this route
The module key the route comes from
The route index in the module
The route description
Gets all matches for a given requested route
Requested route segments
Current Nancy context
A collection of objects
Gets all matches for a given requested route
Requested route segments
Current index in the route segments
Currently captured parameters
Current Nancy context
A collection of objects
Gets a string representation of all routes
Collection of strings, each representing a route
Build the node data that will be used to create the
We calculate/store as much as possible at build time to reduce match time.
Number of nodes in the route
Score for the route
The module key the route comes from
The route index in the module
The route description
A NodeData instance
Returns whether we are at the end of the segments
Route segments
Current index
True if no more segments left, false otherwise
Build the results collection from the captured parameters if
this node is the end result
Currently captured parameters
Parameters captured by the local matching
Array of objects corresponding to each set of stored at this node
Gets all the matches from this node's children
Requested route segments
Current index
Currently captured parameters
Parameters captured by the local matching
Current Nancy context
Collection of objects
Matches the segment for a requested route
Segment string
A instance representing the result of the match
Gets or sets the parent node
Gets or sets the segment from the route definition that this node represents
Gets or sets the children of this node
Gets or sets the node data stored at this node, which will be converted
into the if a match is found
Additional parameters to set that can be determined at trie build time
Score for this node
Matches the segment for a requested route
Segment string
A instance representing the result of the match
Score for this node
A node for constraint captures e.g. {foo:alpha}, {foo:datetime}
Matches the segment for a requested route
Segment string
A instance representing the result of the match
Score for this node
A capture node with a default value e.g. {foo?default}
Add a new route to the trie
Adds itself as a normal capture node, but also sets a default capture
on the parent and adds this node's children as children of the parent
too (so it can effectively be "skipped" during matching)
The segments of the route definition
Current index in the segments array
Current score for this route
Number of nodes added for this route
The module key the route comes from
The route index in the module
The route description
Matches the segment for a requested route
Segment string
A instance representing the result of the match
Score for this node
A node multiple standard captures combined with a literal e.g. {id}.png.{thing}.{otherthing}
Captures parameters within segments that contain literals.
i.e:
/{file}.{name}
/{file}.html
/{major}.{minor}.{revision}B{build}
The parent node
The segment to match upon
The factory
Determines whether this TrieNode should be used for the given segment.
The route segment
a boolean
Matches the segment for a requested route
Segment string
A instance representing the result of the match
Extracts the parameter name and the literals for the segment
Score for this node
A greedy regular expression capture node e.g. ^(?<id>\d{0,100})$
For use on an entire route path, regular expression must be surrounded by ^( )$
e.g. @"^(?:(?<id>videos/\d{1,10})(?:/{0,1}(?<slug>.*)))$"
This will match for a Url like /videos/123/some-random-slug
and capture 'videos/123' and 'some-random-slug'
Gets all matches for a given requested route
Overridden to handle greedy capturing
Requested route segments
Current index in the route segments
Currently captured parameters
Current Nancy context
A collection of objects
Matches the segment for a requested route
Not-required or called for this node type
Segment string
A instance representing the result of the match
Score for this node
A greedy capture node e.g. {greedy*}
e.g. /foo/bar/{greedy*} - this node will be hit for /foo/bar/[anything that doesn't match another route], but
not for just /foo/bar
e.g. /foo/{greedy*}/bar - this node will be hit for /foo/[anything that doesn't match another route]/bar
Gets all matches for a given requested route
Overridden to handle greedy capturing
Requested route segments
Current index in the route segments
Currently captured parameters
Current Nancy context
A collection of objects
Matches the segment for a requested route
Not-required or called for this node type
Segment string
A instance representing the result of the match
Score for this node
Literal string node e.g. goo
Matches the segment for a requested route
Segment string
A instance representing the result of the match
Score for this node
An optional capture node e.g. {foo?}
Add a new route to the trie
Adds itself as a normal capture node, but also adds this node's
children as children of the parent too
(so it can effectively be "skipped" during matching)
The segments of the route definition
Current index in the segments array
Current score for this route
Number of nodes added for this route
The module key the route comes from
The route index in the module
The route description
Matches the segment for a requested route
Segment string
A instance representing the result of the match
Score for this node
A regular expression capture node e.g. (?<foo>\d{2,4})
Matches the segment for a requested route
Segment string
A instance representing the result of the match
Score for this node
Root node of a trie
Gets all matches for a given requested route
Requested route segments
Current index in the route segments
Currently captured parameters
Current Nancy context
A collection of objects
Matches the segment for a requested route
Segment string
A instance representing the result of the match
Score for this node
The default route resolution trie
Build the trie from the route cache
The route cache
Get all matches for the given method and path
HTTP method
Requested path
Current Nancy context
An array of elements
Get all method options for the given path
Requested path
Current Nancy context
A collection of strings, each representing an allowed method
Returns a string that represents the current object.
A string that represents the current object.
2
A segment match result
Gets a value indicating whether the match was successful or not
Gets a representing "no match"
Gets the captured parameters from the match, if the match was successful
Factory for creating the correct type of TrieNode
Gets the correct Trie node type for the given segment
Parent node
Segment
TrieNode instance
Allows a BeforeRequest hook to change Url to HTTPS if X-Forwarded-Proto header present
Checks for Forwarded or X-Forwarded-Proto header and if so makes current url scheme https
Application pipelines
Configuration options for cookie based sessions
Initializes a new instance of the class.
Initializes a new instance of the class.
Gets or sets the cryptography configuration
Formatter for de/serializing the session objects
Cookie name for storing session information
Gets or sets the domain of the session cookie
Gets or sets the path of the session cookie
Gets a value indicating whether the configuration is valid or not.
Registers the static contents hook in the application pipeline at startup.
Initializes a new instance of the class, using the
provided and .
The current root path provider.
The static content conventions.
Perform any initialisation tasks
Enable "manual" static content.
Only use this if you want to manually configure a pipeline hook to have static
content server, for example, after authentication.
The pipelines to hook into
This is a wrapper around the type
IEnumerable<Func<string, object, ViewLocationContext, string>> and its
only purpose is to make Ninject happy which was throwing an exception
when constructor injecting this type.
Calculates how long a byte array of X length will be after base64 encoding
The normal, 8bit per byte, length of the byte array
Base64 encoded length
Cryptographic setup for classes that use encryption and HMAC
Creates a new instance of the CryptographyConfiguration class
Encryption provider
HMAC provider
Gets the default configuration - Rijndael encryption, HMACSHA256 HMAC, random keys
Gets configuration with no encryption and HMACSHA256 HMAC with a random key
Gets the encryption provider
Gets the hmac provider
Provides SHA-256 HMACs
Creates Hash-based Message Authentication Codes (HMACs)
Create a hmac from the given data
Data to create hmac from
Hmac bytes
Create a hmac from the given data
Data to create hmac from
Hmac bytes
Gets the length of the HMAC signature in bytes
Preferred key size for HMACSHA256
HMAC length
Key
Creates a new instance of the DefaultHmacProvider type
Key generator to use to generate the key
Create a hmac from the given data using the given passPhrase
Data to create hmac from
String representation of the hmac
Create a hmac from the given data
Data to create hmac from
Hmac bytes
Gets the length of the HMAC signature
Compare two hmac byte arrays without any early exits
First hmac
Second hmac
Expected length of the hash
True if equal, false otherwise
Provides key byte generation
Generate a sequence of bytes
Number of bytes to return
Array bytes
A "no op" encryption provider
Useful for debugging or performance.
Provides symmetrical encryption support
Encrypt and base64 encode the string
Data to encrypt
Encrypted string
Decrypt string
Data to decrypt
Decrypted string
Encrypt data
Data to encrypt
Encrypted string
Decrypt string
Data to decrypt
Decrypted string
Provides key generation using PBKDF2 / Rfc2898
NOTE: the salt is static so the passphrase should be long and complex
(As the bytes are generated at app startup, because it's too slow to do per
request, so the salt cannot be randomly generated and stored)
Initializes a new instance of the class, with
the provided , and optional
number of
The passphrase that should be used.
The salt
The number of iterations. The default value is 10000.
Generate a sequence of bytes
Number of bytes to return
Array bytes
Generates random secure keys using RNGCryptoServiceProvider
Creates NancyContext instances
Creates NancyContext instances
Create a new NancyContext
NancyContext instance
Creates a new instance of the class.
An instance.
An instance.
An instance.
Create a new instance.
A instance.
The default implementation of the interface.
Gets the generic item store.
An instance containing the items.
Gets or sets the information about the request.
An instance.
Gets or sets the information about the response.
An instance.
Gets or sets the trace log.
A instance.
Initializes a new instance of the class.
The value to store in the instance
Returns a default value if Value is null
When no default value is supplied, required to supply the default type
Optional parameter for default value, if not given it returns default of type T
If value is not null, value is returned, else default value is returned
Attempts to convert the value to type of T, failing to do so will return the defaultValue.
When no default value is supplied, required to supply the default type
Optional parameter for default value, if not given it returns default of type T
If value is not null, value is returned, else default value is returned
Indicates whether the current object is equal to another object of the same type.
true if the current object is equal to the parameter; otherwise, false.
An to compare with this instance.
Determines whether the specified is equal to the current .
true if the specified is equal to the current ; otherwise, false.
The to compare with the current .
Serves as a hash function for a particular type.
A hash code for the current instance.
Provides implementation for binary operations. Classes derived from the class can override this method to specify dynamic behavior for operations such as addition and multiplication.
true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.)
Provides information about the binary operation. The binder.Operation property returns an object. For example, for the sum = first + second statement, where first and second are derived from the DynamicObject class, binder.Operation returns ExpressionType.Add.The right operand for the binary operation. For example, for the sum = first + second statement, where first and second are derived from the DynamicObject class, is equal to second.The result of the binary operation.
Provides implementation for type conversion operations. Classes derived from the class can override this method to specify dynamic behavior for operations that convert an object from one type to another.
true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.)
Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the class, binder.Type returns the type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion.The result of the type conversion operation.
Returns the for this instance.
The enumerated constant that is the of the class or value type that implements this interface.
2
Converts the value of this instance to an equivalent Boolean value using the specified culture-specific formatting information.
A Boolean value equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent Unicode character using the specified culture-specific formatting information.
A Unicode character equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent 8-bit signed integer using the specified culture-specific formatting information.
An 8-bit signed integer equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent 8-bit unsigned integer using the specified culture-specific formatting information.
An 8-bit unsigned integer equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent 16-bit signed integer using the specified culture-specific formatting information.
An 16-bit signed integer equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent 16-bit unsigned integer using the specified culture-specific formatting information.
An 16-bit unsigned integer equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent 32-bit signed integer using the specified culture-specific formatting information.
An 32-bit signed integer equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information.
An 32-bit unsigned integer equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent 64-bit signed integer using the specified culture-specific formatting information.
An 64-bit signed integer equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent 64-bit unsigned integer using the specified culture-specific formatting information.
An 64-bit unsigned integer equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent single-precision floating-point number using the specified culture-specific formatting information.
A single-precision floating-point number equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent double-precision floating-point number using the specified culture-specific formatting information.
A double-precision floating-point number equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent number using the specified culture-specific formatting information.
A number equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent using the specified culture-specific formatting information.
A instance equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an equivalent using the specified culture-specific formatting information.
A instance equivalent to the value of this instance.
An interface implementation that supplies culture-specific formatting information. 2
Converts the value of this instance to an of the specified that has an equivalent value, using the specified culture-specific formatting information.
An instance of type whose value is equivalent to the value of this instance.
The to which the value of this instance is converted. An interface implementation that supplies culture-specific formatting information. 2
Gets a value indicating whether this instance has value.
true if this instance has value; otherwise, false.
is considered as not being a value.
Gets the inner value
Default error handler
Provides informative responses for particular HTTP status codes
Check if the error handler can handle errors of the provided status code.
Status code
The instance of the current request.
True if handled, false otherwise
Handle the error code
Status code
Current context
Initializes a new instance of the type.
The response negotiator.
Whether the status code is handled
Status code
The instance of the current request.
True if handled, false otherwise
Handle the error code
Status code
The instance of the current request.
Nancy Response
A simple pipeline for on-error hooks.
Hooks will be executed until either a hook returns a response, or every
hook has been executed.
Can be implictly cast to/from the on-error hook delegate signature
(Func NancyContext, Exception, Response) for assigning to NancyEngine or for building
composite pipelines.
Pipeline items to execute
Add an item to the start of the pipeline
Item to add
Add an item to the start of the pipeline
Item to add
Whether to replace an existing item with the same name in its current place,
rather than at the position requested. Defaults to false.
Add an item to the end of the pipeline
Item to add
Add an item to the end of the pipeline
Item to add
Whether to replace an existing item with the same name in its current place,
rather than at the position requested. Defaults to false.
Add an item to a specific place in the pipeline.
Index to add at
Item to add
Add an item to a specific place in the pipeline.
Index to add at
Item to add
Whether to replace an existing item with the same name in its current place,
rather than at the position requested. Defaults to false.
Insert an item before a named item.
If the named item does not exist the item is inserted at the start of the pipeline.
Name of the item to insert before
Item to insert
Insert an item before a named item.
If the named item does not exist the item is inserted at the start of the pipeline.
Name of the item to insert before
Item to insert
Insert an item after a named item.
If the named item does not exist the item is inserted at the end of the pipeline.
Name of the item to insert after
Item to insert
Insert an item after a named item.
If the named item does not exist the item is inserted at the end of the pipeline.
Name of the item to insert after
Item to insert
Remove a named pipeline item
Name
Index of item that was removed or -1 if nothing removed
Gets the current pipeline items
Gets the current pipeline item delegates
Invoke the pipeline. Each item will be invoked in turn until either an
item returns a Response, or all items have been invoked.
The current context to pass to the items.
The exception currently being handled by the error pipeline
Response from an item invocation, or null if no response was generated.
Assembly extension methods
Gets exported types from an assembly and catches common errors
that occur when running under test runners.
Assembly to retrieve from
An array of types
Bootstrapper for the Nancy Engine
Initialise the bootstrapper. Must be called prior to GetEngine.
Gets the configured INancyEngine
Configured INancyEngine
Represents a module type for registration into a container
Type of the module
Nancy bootstrapper base class
IoC container type
Stores whether the bootstrapper has been initialised
prior to calling GetEngine.
Stores whether the bootstrapper is in the process of
being disposed.
Stores the used by Nancy
Default Nancy conventions
Internal configuration
Nancy modules - built on startup from the app domain scanner
Initializes a new instance of the class.
Initialise the bootstrapper. Must be called prior to GetEngine.
Gets the diagnostics for initialisation
IDiagnostics implementation
Gets all registered application startup tasks
An instance containing instances.
Registers and resolves all request startup tasks
Container to use
Types to register
An instance containing instances.
Gets all registered application registration tasks
An instance containing instances.
Get all NancyModule implementation instances
The current context
An instance containing instances.
Retrieves a specific implementation - should be per-request lifetime
Module type
The current context
The instance
Gets the configured INancyEngine
Configured INancyEngine
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
2
Hides Equals from the overrides list
Object to compare
Boolean indicating equality
Hides GetHashCode from the overrides list
Hash code integer
Creates and initializes the request pipelines.
The used by the request.
An instance.
Hides ToString from the overrides list
String representation
Initialise the bootstrapper - can be used for adding pre/post hooks and
any other initialisation tasks that aren't specifically container setup
related
Container instance for resolving types if required.
Initialise the request - can be used for adding pre/post hooks and
any other per-request initialisation tasks that aren't specifically container setup
related
Container
Current pipelines
Current context
Configure the application level container with any additional registrations.
Container instance
Overrides/configures Nancy's conventions
Convention object instance
Resolve INancyEngine
INancyEngine implementation
Gets the application level container
Container instance
Register the bootstrapper's implemented types into the container.
This is necessary so a user can pass in a populated container but not have
to take the responsibility of registering things like INancyModuleCatalog manually.
Application container to register into
Register the default implementations of internally used types into the container as singletons
Container to register into
Type registrations to register
Register the various collections into the container as singletons to later be resolved
by IEnumerable{Type} constructor dependencies.
Container to register into
Collection type registrations to register
Register the given module types into the container
Container to register into
NancyModule types
Register the given instances into the container
Container to register into
Instance registration types
Gets additional required type registrations
that don't form part of the core Nancy configuration
Collection of TypeRegistration types
Gets any additional instance registrations that need to
be registered into the container
Collection of InstanceRegistration types
Creates a list of types for the collection types that are
required to be registered in the application scope.
Collection of CollectionTypeRegistration types
Takes the registration tasks and calls the relevant methods to register them
Registration tasks
Application pipelines.
Pipelines are "cloned" per request so they can be modified
at the request level.
Cache of request startup task types
Gets the Container instance - automatically set during initialise.
Nancy internal configuration
Nancy conventions
Gets all available module types
Gets the available view engine types
Gets the available custom model binders
Gets the available custom type converters
Gets the available custom body deserializers
Gets all application startup tasks
Gets all request startup tasks
Gets all registration tasks
Gets the root path provider
Gets the validator factories.
Gets the default favicon
Gets the cryptography configuration
Gets the diagnostics / dashboard configuration (password etc)
Class for locating an INancyBootstrapper implementation.
Will search the app domain for a non-abstract one, and if it can't find one
it will use the default nancy one that uses TinyIoC.
Gets the located bootstrapper
Represents a type to be registered into the container
Represents a type to be registered into the container
Registration type i.e. IMyInterface
Implementation type i.e. MyClassThatImplementsIMyInterface
Lifetime to register the type as
Implementation type i.e. MyClassThatImplementsIMyInterface
Default cookie implementation for Nancy.
The domain to restrict the cookie to
When the cookie should expire
A instance containing the date and time when the cookie should expire; otherwise if it should expire at the end of the session.
The name of the cookie
Gets the encoded name of the cookie
The path to restrict the cookie to
The value of the cookie
Gets the encoded value of the cookie
Whether the cookie is http only
Whether the cookie is secure (i.e. HTTPS only)
Initializes a new instance of the class.
The name of the cookie.
The value of the cookie.
Initializes a new instance of the class.
The name of the cookie.
The value of the cookie.
The expiration date of the cookie. Can be if it should expire at the end of the session.
Initializes a new instance of the class.
The name of the cookie.
The value of the cookie.
Whether the cookie is http only.
Initializes a new instance of the class.
The name of the cookie.
The value of the cookie.
Whether the cookie is http only.
Whether the cookie is secure (i.e. HTTPS only).
Initializes a new instance of the class.
The name of the cookie.
The value of the cookie.
Whether the cookie is http only.
Whether the cookie is secure (i.e. HTTPS only).
The expiration date of the cookie. Can be if it should expire at the end of the session.
The domain to restrict the cookie to
When the cookie should expire
A instance containing the date and time when the cookie should expire; otherwise if it should expire at the end of the session.
The name of the cookie
Gets the encoded name of the cookie
The path to restrict the cookie to
The value of the cookie
Gets the encoded value of the cookie
Whether the cookie is http only
Whether the cookie is secure (i.e. HTTPS only)
TinyIoC bootstrapper - registers default route resolver and registers itself as
INancyModuleCatalog for resolving modules but behaviour can be overridden if required.
Nancy bootstrapper base with per-request container support.
Stores/retrieves the child container in the context to ensure that
only one child container is stored per request, and that the child
container will be disposed at the end of the request.
IoC container type
Context key for storing the child container in the context
Stores the module registrations to be registered into the request container
Get all implementation instances
The current context
An instance containing instances.
Retrieves a specific implementation - should be per-request lifetime
Module type
The current context
The instance
Creates and initializes the request pipelines.
The used by the request.
An instance.
Takes the registration tasks and calls the relevant methods to register them
Registration tasks
Gets the per-request container
Current context
Request container instance
Configure the request container
Request container instance
Register the given module types into the container
Container to register into
NancyModule types
Creates a per request child/nested container
Current context
Request container instance
Register the given module types into the request container
Container to register into
NancyModule types
Retrieve all module instances from the container
Container to use
Collection of NancyModule instances
Retrieve a specific module instance from the container
Container to use
Type of the module
NancyModule instance
Stores the per-request type registrations
Stores the per-request collection registrations
Gets the context key for storing the child container in the context
Default assemblies that are ignored for autoregister
Configures the container using AutoRegister followed by registration
of default INancyModuleCatalog and IRouteResolver.
Container instance
Resolve INancyEngine
INancyEngine implementation
Create a default, unconfigured, container
Container instance
Register the bootstrapper's implemented types into the container.
This is necessary so a user can pass in a populated container but not have
to take the responsibility of registering things like INancyModuleCatalog manually.
Application container to register into
Register the default implementations of internally used types into the container as singletons
Container to register into
Type registrations to register
Register the various collections into the container as singletons to later be resolved
by IEnumerable{Type} constructor dependencies.
Container to register into
Collection type registrations to register
Register the given module types into the container
Container to register into
NancyModule types
Register the given instances into the container
Container to register into
Instance registration types
Creates a per request child/nested container
Current context
Request container instance
Gets the diagnostics for initialisation
IDiagnostics implementation
Gets all registered startup tasks
An instance containing instances.
Gets all registered request startup tasks
An instance containing instances.
Gets all registered application registration tasks
An instance containing instances.
Retrieve all module instances from the container
Container to use
Collection of NancyModule instances
Retrieve a specific module instance from the container
Container to use
Type of the module
NancyModule instance
Executes auto registation with the given container.
Container instance
Gets the assemblies to ignore when autoregistering the application container
Return true from the delegate to ignore that particular assembly, returning false
does not mean the assembly *will* be included, a true from another delegate will
take precedence.
Containing extensions for the object
Ascertains if a request originated from an Ajax request or not.
The current nancy context
True if the request was done using ajax, false otherwise
Expands a path to take into account a base path (if any)
Nancy context
Path to expand
Expanded path
Returns a redirect response with the redirect path expanded to take into
account a base path (if any)
Nancy context
Path to redirect to
Redirect response
Retrieves exception details from the context, if any exist
Nancy context
Exception details
Get a thrown exception from the context.
The context.
The thrown exception or null if not exception has been thrown.
Get a thrown exception of the given type from the context.
The type of exception to get.
The context.
The thrown exception or null if not exception has been thrown.
Tries to get a thrown exception from the context.
The context.
The thrown exception.
true if an exception has been thrown during the request, false otherwise.
Tries to get a thrown exception of the given type from the context.
The type of exception to get.
The context.
The thrown exception.
true if an exception of the given type has been thrown during the request, false otherwise.
Shortcut extension method for writing trace information
Nancy context
Log delegate
Returns a boolean indicating whether a given url string is local or not
Nancy context
Url string (relative or absolute)
True if local, false otherwise
Containing extensions for implementations.
A regular expression used to manipulate parameterized route segments.
A object.
Extracts the friendly name of a Nancy module given its type.
The module instance
A string containing the name of the parameter.
Returns a boolean indicating whether the route is executing, or whether the module is
being constructed.
The module instance
True if the route is being executed, false if the module is being constructed
Adds the before delegate to the Before pipeline if the module is not currently executing,
or executes the delegate directly and returns any response returned if it is.
Uses
Current module
Delegate to add or execute
Optional reason for the early exit (if necessary)
Containing extensions for the object
An extension method making it easy to check if the request was done using ajax
The request made by client
if the request was done using ajax, otherwise .
Gets a value indicating whether the request is local.
The request made by client
if the request is local, otherwise .
Containing extensions for the object.
A regular expression used to manipulate parameterized route segments.
A object.
Extracts information about the parameters in the .
The segment that the information should be extracted from.
An , containing instances for the parameters in the segment.
Checks if a segment contains any parameters.
The segment to check for parameters.
true if the segment contains a parameter; otherwise false.
A parameter is defined as a string which is surrounded by a pair of curly brackets.
The provided value for the segment parameter was null or empty.
Gets a dynamic dictionary back from a Uri query string
The query string to extract values from
A dynamic dictionary containing the query string values
Converts the value from PascalCase to camelCase.
The value.
System.String.
Converts the value from camelCase to PascalCase.
The value.
System.String.
Provides strongly-typed access to HTTP request headers.
Initializes a new instance of the class.
The headers.
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
Returns an enumerator that iterates through a collection.
An object that can be used to iterate through the collection.
Content-types that are acceptable.
An that contains the header values if they are available; otherwise it will be empty.
Character sets that are acceptable.
An that contains the header values if they are available; otherwise it will be empty.
Acceptable encodings.
An that contains the header values if they are available; otherwise it will be empty.
Acceptable languages for response.
An that contains the header values if they are available; otherwise it will be empty.
Authorization header value for request.
A containing the header value if it is available; otherwise .
Used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
An that contains the header values if they are available; otherwise it will be empty.
Contains name/value pairs of information stored for that URL.
An that contains instances if they are available; otherwise it will be empty.
What type of connection the user-agent would prefer.
A containing the header value if it is available; otherwise .
The length of the request body in octets (8-bit bytes).
The length of the contents if it is available; otherwise 0.
The mime type of the body of the request (used with POST and PUT requests).
A containing the header value if it is available; otherwise .
The date and time that the message was sent.
A instance that specifies when the message was sent. If not available then will be returned.
The domain name of the server (for virtual hosting), mandatory since HTTP/1.1
A containing the header value if it is available; otherwise .
Only perform the action if the client supplied entity matches the same entity on the server. This is mainly for methods like PUT to only update a resource if it has not been modified since the user last updated it.
An that contains the header values if they are available; otherwise it will be empty.
Allows a 304 Not Modified to be returned if content is unchanged
A instance that specifies when the requested resource must have been changed since. If not available then will be returned.
Allows a 304 Not Modified to be returned if content is unchanged
An that contains the header values if they are available; otherwise it will be empty.
If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity.
A containing the header value if it is available; otherwise .
Only send the response if the entity has not been modified since a specific time.
A instance that specifies when the requested resource may not have been changed since. If not available then will be returned.
Gets the names of the available request headers.
An containing the names of the headers.
Limit the number of times the message can be forwarded through proxies or gateways.
The number of the maximum allowed number of forwards if it is available; otherwise 0.
This is the address of the previous web page from which a link to the currently requested page was followed.
A containing the header value if it is available; otherwise .
The user agent string of the user agent
A containing the header value if it is available; otherwise .
Gets all the header values.
An that contains all the header values.
Gets the values for the header identified by the parameter.
The name of the header to return the values for.
An that contains the values for the header. If the header is not defined then is returned.
Represents a HTML (text/html) response
Creates a new instance of the HtmlResponse class
Status code - defaults to OK
Response body delegate - defaults to empty if null
Headers if required
Cookies if required
Csrf protection methods
Enables Csrf token generation.
This is disabled by default.
Application pipelines
Disable csrf token generation
Application pipelines
Creates a new csrf token for this response with an optional salt.
Only necessary if a particular route requires a new token for each request.
Nancy module
Creates a new csrf token with an optional salt.
Does not store the token in context.
The generated token
Validate that the incoming request has valid CSRF tokens.
Throws if validation fails.
Module object
Optional validity period before it times out
If validation fails
Wires up the CSRF (anti-forgery token) support at application startup.
Initializes a new instance of the class, using the
provided , and .
The cryptographic configuration to use.
The serializer that should be used.
The token validator that should be used.
Perform any initialisation tasks
Application pipelines
Gets the configured crypto config
Gets the configured object serialiser
Gets the configured token validator
Represents a Csrf protection token
The default key for the csrf cookie/form value/querystring value
Determines whether the specified is equal to the current .
true if the specified is equal to the current ; otherwise, false.
The to compare with the current . 2
Serves as a hash function for a particular type.
A hash code for the current .
2
Randomly generated bytes
Date and time the token was created
Tamper prevention hmac
Gets a byte array representation of the csrf token for generating
hmacs
Token
Byte array representing the token
Calculates and sets the Hmac property on a given token
Token
Hmac provider to use
Hmac bytes
Creates random bytes for the csrf token
Random byte array
The default implementation of the interface.
Validates Csrf tokens
Validates a pair of tokens
First token (usually from either a form post or querystring)
Second token (usually from a cookie)
Optional period that the tokens are valid for
Token validation result
Validates that a cookie token is still valid with the current configuration / keys
Token to validate
True if valid, false otherwise
Initializes a new instance of the class,
using the provided .
The that should be used.
Validates a pair of tokens
First token (usually from either a form post or querystring)
Second token (usually from a cookie)
Optional period that the tokens are valid for
Token validation result
Validates that a cookie token is still valid with the current configuration / keys
Token to validate
True if valid, false otherwise
Result of Csrf Token validation
Validated ok
One or both of the tokens appears to have been tampered with
One or both of the tokens are missing
Tokens to not match
Token is valid, but has expired
Containing extensions for the object.
Force the response to be downloaded as an attachment
Response object
Filename for the download
Optional content type
Modified Response object
Adds a to the response.
Response object
The name of the cookie.
The value of the cookie.
The instance.
Adds a to the response.
Response object
The name of the cookie.
The value of the cookie.
The expiration date of the cookie. Can be if it should expire at the end of the session.
The instance.
Adds a to the response.
Response object
The name of the cookie.
The value of the cookie.
The expiration date of the cookie. Can be if it should expire at the end of the session.
The domain of the cookie.
The path of the cookie.
The instance.
Adds a to the response.
Response object
A instance.
Add a header to the response
Response object
Header name
Header value
Modified response
Adds headers to the response using anonymous types
Response object
Array of headers - each header should be an anonymous type with two string properties
'Header' and 'Value' to represent the header name and its value.
Modified response
Adds headers to the response using anonymous types
Response object
Array of headers - each header should be a Tuple with two string elements
for header name and header value
Modified response
Sets the content type of the response
Response object
The type of the content
Modified response
Sets the status code of the response
Response object
The http status code
Modified response
Sets the status code of the response
Response object
The http status code
Modified response
Assigns the root path of the application whom ever needs it.
This task is run at application startup.
Initializes a new instance of the class.
An instance.
Perform any initialisation tasks
Defines the core functionality of an identity
The username of the authenticated user.
A containing the username.
The claims of the authenticated user.
An , containing the claims.
Gets or sets a value indicating whether or not to disable traces in error messages
Gets or sets a value indicating whether or not to respond with 405 responses
Gets or sets a value indicating whether or not to enable case sensitivity in query, parameters (DynamicDictionary) and model binding. Enable this to conform with RFC3986.
Gets or sets a value indicating whether or not to route HEAD requests explicitly.
Gets a value indicating whether we are running in debug mode or not.
Checks the entry assembly to see whether it has been built in debug mode.
If anything goes wrong it returns false.
Gets or sets the limit on the number of query string variables, form fields,
or multipart sections in a request.
Gets or sets a value indicating whether or not to enable request tracing
Gets or sets a value indicating whether or not to disable request stream switching
Gets or sets a value indicating whether this allow file stream
upload async due to mono issues before v4. Uploads of over 80mb would result in extra padded chars to the filestream corrupting the file.
true if allow file stream upload async; otherwise, false.
Gets or sets a value indicating whether or not to enable runtime view discovery
Defaults to True in debug mode and False in release mode
Gets or sets a value indicating whether or not to allow runtime changes of views
Defaults to True in debug mode and False in release mode
Represents a full Url of the form scheme://hostname:port/basepath/path?query
Since this is for internal use, and fragments are not passed to the server, fragments are not supported.
Creates an instance of the class
Creates an instance of the class
A containing a URL.
Clones the url.
Returns a new cloned instance of the url.
Clones the url.
Returns a new cloned instance of the url.
Casts the current instance to a instance.
The instance that should be cast.
A representation of the .
Casts the current instance to a instance.
The instance that should be cast.
An representation of the .
Casts the current instance to a instance.
The instance that should be cast.
An representation of the .
Casts a instance to a instance
The instance that should be cast.
An representation of the .
Gets or sets the HTTP protocol used by the client.
The protocol.
Gets the hostname of the request
Gets the port name of the request
Gets the base path of the request i.e. the "Nancy root"
Gets the path of the request, relative to the base path
This property drives the route matching
Gets the querystring data of the requested resource.
Gets the domain part of the request
Gets whether the url is secure or not.
A composite validator to combine other validators.
Provides a way to validate a type as well as a description to use for client-side validation.
Validates the specified instance.
The instance that should be validated.
The of the current request.
A with the result of the validation.
Gets the description of the validator.
Gets the of the model that is being validated by the validator.
Initializes a new instance of the class.
The validators.
The type of the model that is being validated.
Validates the specified instance.
The instance that should be validated.
The of the current request.
A with the result of the validation.
Gets the description of the validator.
The type of the model that is being validated by the validator.
The default Nancy implementation of IValidatorLocator.
Locates a validator for a given type.
Gets a validator for a given type.
The type to validate.
An instance or if none found.
Initializes a new instance of the class.
The factories.
Gets a validator for a given type.
The type to validate.
An instance or if none found.
Creates instances of IValidator.
Creates a validator for the given type.
The type.
A validator for the given type or null if none exists.
Exception that is thrown during problems with model validation.
Initializes a new instance of the class.
Initializes a new instance of the class,
with the provided .
The error message that explains the reason for the exception.
Initializes a new instance of the class,
with the provided and
The error message that explains the reason for the exception.
The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
Extensions to for validation.
Performs validation on the specified .
The type of the that is being validated.
The module that the validation is performed from.
The instance that is being validated.
A instance.
Specifies the validation comparison operators used by the type.
A comparison for greater than.
A comparison for greater than or equal to.
A comparison for less than.
A comparison for less than or equal to.
A comparison for equality.
A comparison for inequality.
Implementation of for ensuring a string does not
contain an empty value.
A description of a validation rule.
Initializes a new instance of the class.
Type of the rule.
The error message formatter.
Initializes a new instance of the class.
Type of the rule.
The error message formatter.
Name of the member.
Gets the error message that this rule will provide upon error.
The name.
The error message.
Gets the names of the members this rule validates.
An that contains the name of the member.
Gets the type of the rule.
The type of the rule.
Initializes a new instance of the class.
The error message formatter.
The member names.
Implementation of for ensuring a string is not null.
Initializes a new instance of the class.
The error message formatter.
The member names.
Implementation of for comparing two values using a
provided .
Initializes a new instance of the class.
The error message formatter.
The member names.
The that should be used when comparing values.
Gets the value to compare against.
The that should be used when comparing values.
A value.
Gets the value to compare against.
Implementation of for ensuring a string matches the
pattern which is defined by a regex.
Initializes a new instance of the class.
The error message formatter.
The member names.
The regex pattern that should be used to check for a match.
The regex pattern that should be used to check for a match.
Implementation of for ensuring that the length of a string
is withing the specified range.
Initializes a new instance of the class.
The error message formatter.
The member names.
Minimum allowed length of the string
Maximum allowed length of the string
Gets the length of the min.
The length of the min.
Gets the length of the max.
The length of the max.
A description of the rules a validator provides.
Initializes a new instance of the class.
The rules that describes the model.
The type of the model that the rules are defined for.
Initializes a new instance of the class.
The rules that describes the model, grouped by member name.
The type of the model that the rules are defined for.
The type of the model that is being described.
Gets the rules.
An instance that contains instances grouped by property name.
Represents a model validation error.
Initializes a new instance of the class.
Name of the member that the error describes.
Initializes a new instance of the class.
The member names that the error describes.
Implicitly cast a validation error to a string.
The that should be cast.
A containing the validation error description.
Returns the .
A string containing the error message.
Gets the member names that are a part of the error.
An that contains the name of the members.
Represents the result of a model validation.
Initializes a new instance of the class.
Initializes a new instance of the class.
The instances that makes up the result.
Initializes a new instance of the class.
The instances that makes up the result, grouped by member name.
Gets the errors.
An instance that contains instances grouped by property name.
Gets a clean representation of the errors.
Gets a value indicating whether the validated instance is valid or not.
if the validated instance is valid; otherwise, .
Default implementation for retrieving information about views that are stored on the file system.
Defines the functionality for retrieving information about views that are stored on the file system.
Gets information about view that are stored in folders below the applications root path.
The path of the folder where the views should be looked for.
A list of view extensions to look for.
An containing view locations and contents readers.
Gets the last modified time for the file specified
Filename
Time the file was last modified
Gets information about specific views that are stored in folders below the applications root path.
The path of the folder where the views should be looked for.
Name of the view to search for
A list of view extensions to look for.
An containing view locations and contents readers.
Gets information about view that are stored in folders below the applications root path.
The path of the folder where the views should be looked for.
A list of view extensions to look for.
An containing view locations and contents readers.
Gets the last modified time for the file specified
Filename
Time the file was last modified
Gets information about specific views that are stored in folders below the applications root path.
The path of the folder where the views should be looked for.
Name of the view to search for
A list of view extensions to look for.
An containing view locations and contents readers.
Default render context implementation.
Defines the functionality of the context that is passed into a view engine when the view is requested to be rendered.
Parses a path and returns an absolute url path, taking into account
base directory etc.
Input url such as ~/styles/main.css
Parsed absolute url path
HTML encodes a string.
The string that should be HTML encoded.
A HTML encoded .
Locates a view that matches the provided and .
The name of the view that should be located.
The model that should be used when locating the view.
A instance if the view could be located; otherwise, .
Gets the current Csrf token.
The token should be stored in a cookie and the form as a hidden field.
In both cases the name should be the key of the returned key value pair.
A tuple containing the name (cookie name and form/querystring name) and value
Gets the context of the current request.
A instance.
Gets the view cache that is used by Nancy.
An instance.
Gets the text resource for localisation
Gets the text resource finder for localisation
Initializes a new instance of the class.
Parses a path and returns an absolute url path, taking into account
base directory etc.
Input url such as ~/styles/main.css
Parsed absolute url path
HTML encodes a string.
The string that should be HTML encoded.
A HTML encoded .
Locates a view that matches the provided and .
The name of the view that should be located.
The model that should be used when locating the view.
A instance if the view could be located; otherwise, .
Generates a Csrf token.
The token should be stored in a cookie and the form as a hidden field.
In both cases the name should be the key of the returned key value pair.
A tuple containing the name (cookie name and form/querystring name) and value
Gets the context of the current request.
A instance.
Gets the view cache that is used by Nancy.
An instance.
Gets the text resource for localisation
Gets the text resource finder for localisation
Default render context factory implementation.
Defines the functionality required to manufacture instances.
Gets a for the specified .
The for which the context should be created.
A instance.
Initializes a new instance of the class.
The view cache that should be used by the created render context.
The view resolver that should be used by the created render context.
The that should be used by the engine.
Gets a for the specified .
The for which the context should be created.
A instance.
Default set of assemblies that should be scanned for items (views, text, content etc)
embedded as resources.
The default convention will scan all assemblies that references another assemblies that has a name that starts with Nancy*
Defines the functionality for retrieving which assemblies that should be used by Nancy.
Gets a list of assemblies that should be scanned.
An of instances.
Gets a list of assemblies that should be scanned for views.
An of instances.
Default implementation for extracting view information form an assembly.
Defines the functionality of a reader that extracts embedded views from an assembly.
Gets information about the resources that are embedded in the assembly.
The to retrieve view information from.
A list of view extensions to look for.
A of resource locations and content readers.
Gets information about the resources that are embedded in the assembly.
The to retrieve view information from.
A list of view extensions to look for.
A of resource locations and content readers.
Resource based implementation of
Initializes a new instance of to read strings from *.resx files
The that should be used when scanning.
Used to return a string value from *.resx files
The key to look for in the resource file
The used to determine the culture for returning culture specific values.
Returns a string value from culture specific or default file or null if key does not exist as determined by .
Default implementation of the interface.
Interface for manually rendering views to a Response object, rather
than going through content negotiation.
Renders a view to a response object, bypassing content negotiation.
Current Nancy context
View name
Model object (or null)
Response object containing the rendered view (if found)
Initializes an instance of the type, with
the provided .
The that should be used to render the views.
Renders a view to a response object, bypassing content negotiation.
Current Nancy context
View name
Model object (or null)
Response object containing the rendered view (if found)
View cache that supports expiring content if it is stale
Defines the functionality of a Nancy view cache.
Gets or adds a view from the cache.
The type of the cached view instance.
A instance that describes the view that is being added or retrieved from the cache.
A function that produces the value that should be added to the cache in case it does not already exist.
An instance of the type specified by the type.
Initializes a new instance of the class.
Gets or adds a view from the cache.
The type of the cached view instance.
A instance that describes the view that is being added or retrieved from the cache.
A function that produces the value that should be added to the cache in case it does not already exist.
An instance of the type specified by the type.
Contains miscellaneous extension methods.
Checks if the evaluated instance is an anonymous
The object instance to check.
if the object is an anonymous type; otherwise .
Contains the functionality for locating a view that is located on the file system.
Defines the functionality used by Nancy to located a view.
Returns an instance for all the views that could be located by the provider.
An instance, containing the view engine file extensions that is supported by the running instance of Nancy.
An instance, containing instances for the located views.
If no views could be located, this method should return an empty enumerable, never .
Returns an instance for all the views matching the viewName that could be located by the provider.
An instance, containing the view engine file extensions that is supported by the running instance of Nancy.
Location of the view
The name of the view to try and find
An instance, containing instances for the located views.
If no views could be located, this method should return an empty enumerable, never .
Initializes a new instance of the class.
A instance.
Creating an instance using this constructor will result in the being used internally.
Initializes a new instance of the class.
A instance.
An instance that should be used when retrieving view information from the file system.
Returns an instance for all the views that could be located by the provider.
An instance, containing the view engine file extensions that is supported by the running instance of Nancy.
An instance, containing instances for the located views.
If no views could be located, this method should return an empty enumerable, never .
Returns an instance for all the views matching the viewName that could be located by the provider.
An instance, containing the view engine file extensions that is supported by the running instance of Nancy.
The name of the view to try and find
An instance, containing instances for the located views.
If no views could be located, this method should return an empty enumerable, never .
Represents a HEAD only response.
Initializes a new instance of the class.
The full response to create the head response from.
Containing extensions for the collection objects.
Converts a to a instance.
The to convert.
An instance.
Converts an instance to a instance.
The instance to convert.
A instance.
Merges a collection of instances into a single one.
The list of instances to merge.
An instance containing the keys and values from the other instances.
Filters a collection based on a provided key selector.
The collection filter.
The predicate to filter by.
The type of the collection to filter.
The type of the key to filter by.
A instance with the filtered values.
Decodes an HTML-encoded string and returns the decoded string.
The HTML string to decode.
The decoded text.
Decodes an HTML-encoded string and sends the resulting output to a TextWriter output stream.
The HTML string to decode
The TextWriter output stream containing the decoded string.
HTML-encodes a string and sends the resulting output to a TextWriter output stream.
The string to encode.
The TextWriter output stream containing the encoded string.
Represents a file that was captured in a HTTP multipart/form-data request
Initializes a new instance of the class,
using the provided .
The that contains the file information.
Initializes a new instance of the class,
using the provided values
The content type of the file.
The name of the file.
The content of the file.
The name of the field that uploaded the file.
Gets or sets the type of the content.
A containing the content type of the file.
Gets or sets the name of the file.
A containing the name of the file.
Gets or sets the form element name of this file.
A containing the key.
Gets or sets the value stream.
A containing the contents of the file.
This is a instance that sits ontop of the request stream.
Retrieves instances from a request stream.
Initializes a new instance of the class.
The request stream to parse.
The boundary marker to look for.
Gets the instances from the request stream.
An instance, containing the found instances.
Represents the content boundary of a HTTP multipart/form-data boundary in a stream.
Initializes a new instance of the class.
The stream that contains the boundary information.
Gets the contents type of the boundary value.
A containing the name of the value if it is available; otherwise .
Gets or the filename for the boundary value.
A containing the filename value if it is available; otherwise .
This is the RFC2047 decoded value of the filename attribute of the Content-Disposition header.
Gets name of the boundary value.
This is the RFC2047 decoded value of the name attribute of the Content-Disposition header.
A stream containing the value of the boundary.
This is the RFC2047 decoded value of the Content-Type header.
A buffer that is used to locate a HTTP multipart/form-data boundary in a stream.
Initializes a new instance of the class.
The boundary as a byte-array.
The closing boundary as byte-array
Resets the buffer so that inserts happens from the start again.
This does not clear any previously written data, just resets the buffer position to the start. Data that is inserted after Reset has been called will overwrite old data.
Inserts the specified value into the buffer and advances the internal position.
The value to insert into the buffer.
This will throw an is you attempt to call insert more times then the of the buffer and was not invoked.
Gets a value indicating whether the buffer contains the same values as the boundary.
if buffer contains the same values as the boundary; otherwise, .
Gets a value indicating whether this buffer is full.
if buffer is full; otherwise, .
Gets the number of bytes that can be stored in the buffer.
The number of bytes that can be stored in the buffer.
HTTP Status Codes
The values are based on the list found at http://en.wikipedia.org/wiki/List_of_HTTP_status_codes
100 Continue
101 SwitchingProtocols
102 Processing
103 Checkpoint
200 OK
201 Created
202 Accepted
203 NonAuthoritativeInformation
204 NoContent
205 ResetContent
206 PartialContent
207 MultipleStatus
226 IMUsed
300 MultipleChoices
301 MovedPermanently
302 Found
303 SeeOther
304 NotModified
305 UseProxy
306 SwitchProxy
307 TemporaryRedirect
308 ResumeIncomplete
400 BadRequest
401 Unauthorized
402 PaymentRequired
403 Forbidden
404 NotFound
405 MethodNotAllowed
406 NotAcceptable
407 ProxyAuthenticationRequired
408 RequestTimeout
409 Conflict
410 Gone
411 LengthRequired
412 PreconditionFailed
413 RequestEntityTooLarge
414 RequestUriTooLong
415 UnsupportedMediaType
416 RequestedRangeNotSatisfiable
417 ExpectationFailed
418 ImATeapot
420 Enhance Your Calm
422 UnprocessableEntity
423 Locked
424 FailedDependency
425 UnorderedCollection
426 UpgradeRequired
429 Too Many Requests
444 NoResponse
449 RetryWith
450 BlockedByWindowsParentalControls
499 ClientClosedRequest
500 InternalServerError
501 NotImplemented
502 BadGateway
503 ServiceUnavailable
504 GatewayTimeout
505 HttpVersionNotSupported
506 VariantAlsoNegotiates
507 InsufficientStorage
509 BandwidthLimitExceeded
510 NotExtended
An extension point for adding support for formatting response contents. No members should be added to this interface without good reason.
Extension methods to this interface should always return or one of the types that can implicitly be types into a .
Gets all serializers currently registered
Gets the context for which the response is being formatted.
A instance.
Gets the root path of the application.
A containing the root path.
Attempts to detect if the content type is JSON.
Supports:
application/json
text/json
[something]+json
Matches are case insensitive to try and be as "accepting" as possible.
Request content type
True if content type is JSON, false otherwise
Gets the type of the typed list's items.
The type.
The type of the typed list's items.
Determines whether the member is an indexed property.
The member.
true if the member is an indexed property; otherwise, false.
Determines whether the property is an indexed property.
The property.
true if the property is an indexed property; otherwise, false.
Gets the member's value on the object.
The member.
The target object.
The member's value on the object.
Sets the member's value on the target object.
The member.
The target.
The value.
Determines whether the specified MemberInfo can be read.
The MemberInfo to determine whether can be read.
true if the specified MemberInfo can be read; otherwise, false.
Determines whether the specified MemberInfo can be set.
The MemberInfo to determine whether can be set.
true if the specified MemberInfo can be set; otherwise, false.
Model binding context object
The binding configuration
Current Nancy context
Binding destination type
The generic type of a collection is only used when DestinationType is a enumerable.
The current model object (or null for body deserialization)
DestinationType properties that are not black listed
The incoming data fields
Available type converters - user converters followed by any defaults
Provides default binding converters/deserializers
The defaults have less precedence than any user supplied ones
Initializes a new instance of the class.
Gets the default type converters
Gets the default type converters
Default binder - used as a fallback when a specific modelbinder
is not available.
Binds incoming request data to a model type
Bind to the given model type
Current context
Model type to bind to
The that should be applied during binding.
Blacklisted property names
Existing instance of the object
Bound model
Bind to the given model type
Current context
Model type to bind to
Optional existing instance
The that should be applied during binding.
Blacklisted binding property names
Bound model
Gets the number of distinct indexes from context:
i.e:
IntProperty_5
StringProperty_5
IntProperty_7
StringProperty_8
You'll end up with a list of 3 matches: 5,7,8
Current Context
An int containing the number of elements
Deserializes request bodies in JSON format
Provides a way to deserialize the contents of a request
into a bound model.
Whether the deserializer can deserialize the content type
Content type to deserialize
Current .
True if supported, false otherwise
Deserialize the request body to a model
Content type to deserialize
Request body stream
Current .
Model instance
Whether the deserializer can deserialize the content type
Content type to deserialize
Current .
True if supported, false otherwise
Deserialize the request body to a model
Content type to deserialize
Request body stream
Current context
Model instance
Deserializes request bodies in XML format
Whether the deserializer can deserialize the content type
Content type to deserialize
Current .
True if supported, false otherwise
Deserialize the request body to a model
Content type to deserialize
Request body stream
Current .
Model instance
Converter for handling enumerable types
Whether the converter can convert to the destination type
Destination type
The current binding context
True if conversion supported, false otherwise
Convert the string representation to the destination type
Input string
Destination type
Current context
Converted object of the destination type
A fallback converter that uses TypeDescriptor.GetConverter to try
and convert the value.
Whether the converter can convert to the destination type
Destination type
The current binding context
True if conversion supported, false otherwise
Convert the string representation to the destination type
Input string
Destination type
Current context
Converted object of the destination type
Default field name converter
Converts camel case to pascal case
Provides the capability to supply a convention to
convert form field names to property names if required.
Converts a field name to a property name
Field name
Property name
Converts a field name to a property name
Field name
Property name
Provides wiring up of a model binder when cast to a destination type
Initializes a new instance of the class.
Model binder locator
Nancy context
Optional existing instance, or null
The that should be applied during binding.
Blacklisted property names
Provides implementation for type conversion operations. Classes derived from the class can override this method to specify dynamic behavior for operations that convert an object from one type to another.
true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.)
Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the class, binder.Type returns the type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion.The result of the type conversion operation.
Provides a way to bind an incoming request, via the context, to a model type
Whether the binder can bind to the given model type
Required model type
True if binding is possible, false otherwise
Locates model binders for a particular model
Gets a binder for the given type
Destination type to bind to
The instance of the current request.
IModelBinder instance or null if none found
Locates model binders for a particular model
Available model binders
Default model binder to fall back on
Initializes a new instance of the class.
Available model binders
Fallback binder
Gets a binder for the given type
Destination type to bind to
The instance of the current request.
IModelBinder instance or null if none found
Represents an exception when attempting to bind to a model
Initializes a new instance of the ModelBindingException class with a specified model type,
property name and the original exception, which caused the problem
the model type to bind to
the original exceptions, thrown while binding the property
The inner exception.
Initializes a new instance of the class with serialized data.
The that holds the serialized object data about the exception being thrown.
The that contains contextual information about the source or destination.
Gets all failures
Gets the model type, which caused the exception
Parses an array of expressions like t => t.Property
to a list of strings containing the property names;
Type of the model
Expressions that tell which property should be ignored
Array of strings containing the names of the properties.
Bind the incoming request to a model
Current module
Property names to blacklist from binding
Model adapter - cast to a model type to bind it
Bind the incoming request to a model
Current module
The that should be applied during binding.
Property names to blacklist from binding
Model adapter - cast to a model type to bind it
Bind the incoming request to a model
Model type
Current module
Bound model instance
Bind the incoming request to a model
Model type
Current module
Property names to blacklist from binding
Bound model instance
Bind the incoming request to a model
Model type
Current module
Expressions that tell which property should be ignored
this.Bind<Person>(p => p.Name, p => p.Age)
Bound model instance
Bind the incoming request to a model and validate
Model type
Current module
Property names to blacklist from binding
Bound model instance
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Bind the incoming request to a model and validate
Model type
Current module
Expressions that tell which property should be ignored
this.Bind<Person>(p => p.Name, p => p.Age)
Bound model instance
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Bind the incoming request to a model and validate
Model type
Current module
Bound model instance
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Bind the incoming request to a model
Model type
Current module
The that should be applied during binding.
Bound model instance
Bind the incoming request to a model
Model type
Current module
The that should be applied during binding.
Property names to blacklist from binding
Bound model instance
Bind the incoming request to a model
Model type
Current module
The that should be applied during binding.
Expressions that tell which property should be ignored
this.Bind<Person>(p => p.Name, p => p.Age)
Bound model instance
Bind the incoming request to a model
Model type
Current module
The that should be applied during binding.
Expressions that tell which property should be ignored
this.Bind<Person>(p => p.Name, p => p.Age)
Bound model instance
Bind the incoming request to a model and validate
Model type
Current module
The that should be applied during binding.
Property names to blacklist from binding
Bound model instance
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Bind the incoming request to a model and validate
Model type
Current module
The that should be applied during binding.
Expressions that tell which property should be ignored
this.Bind<Person>(p => p.Name, p => p.Age)
Bound model instance
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Bind the incoming request to a model and validate
Model type
Current module
The that should be applied during binding.
Bound model instance
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Bind the incoming request to an existing instance
Model type
Current module
The class instance to bind properties to
Property names to blacklist from binding
Bind the incoming request to an existing instance
Model type
Current module
The class instance to bind properties to
Expressions that tell which property should be ignored
this.Bind<Person>(p => p.Name, p => p.Age)
Bind the incoming request to an existing instance
Model type
Current module
The class instance to bind properties to
Bind the incoming request to an existing instance and validate
Model type
Current module
The class instance to bind properties to
Property names to blacklist from binding
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Bind the incoming request to an existing instance and validate
Model type
Current module
The class instance to bind properties to
Expressions that tell which property should be ignored
this.Bind<Person>(p => p.Name, p => p.Age)
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Bind the incoming request to an existing instance and validate
Model type
Current module
The class instance to bind properties to
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Bind the incoming request to an existing instance
Model type
Current module
The class instance to bind properties to
The that should be applied during binding.
Property names to blacklist from binding
Bind the incoming request to an existing instance
Model type
Current module
The class instance to bind properties to
The that should be applied during binding.
Expressions that tell which property should be ignored
this.Bind<Person>(p => p.Name, p => p.Age)
Bind the incoming request to an existing instance
Model type
Current module
The class instance to bind properties to
The that should be applied during binding.
Bind the incoming request to an existing instance and validate
Model type
Current module
The class instance to bind properties to
The that should be applied during binding.
Property names to blacklist from binding
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Bind the incoming request to an existing instance and validate
Model type
Current module
The class instance to bind properties to
The that should be applied during binding.
Expressions that tell which property should be ignored
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
this.BindToAndValidate(person, config, p => p.Name, p => p.Age)
Bind the incoming request to an existing instance and validate
Model type
Current module
The class instance to bind properties to
The that should be applied during binding.
is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult.
Nancy context.
Initializes a new instance of the class.
Disposes any disposable items in the dictionary.
Gets the dictionary for storage of per-request items. Disposable items will be disposed when the context is.
Gets or sets the resolved route
Gets or sets the parameters for the resolved route
Gets or sets the incoming request
Gets or sets the outgoing response
Gets or sets the current user
Diagnostic request tracing
Gets a value indicating whether control panel access is enabled for this request
Non-model specific data for rendering in the response
Gets or sets the model validation result.
Gets or sets the context's culture
Context of content negotiation (if relevant)
Gets or sets the dynamic object used to locate text resources.
Wraps a sync delegate into it's async form
Sync pipeline item instance
Async pipeline item instance
Wraps a sync delegate into it's async form
Sync pipeline item instance
Async pipeline item instance
The default implementation of the interface.
Initializes a new instance of the class.
The that should be used by the instance.
The that should be used by the instance.
Gets all serializers currently registered
Gets the context for which the response is being formatted.
A instance.
Gets the root path of the application.
A containing the root path.
A decorator that can handle moving the stream out from memory and on to disk when the contents reaches a certain length.
Initializes a new instance of the class.
The expected length of the contents in the stream.
The content length that will trigger the stream to be moved out of memory.
if set to the stream will never explicitly be moved to disk.
Initializes a new instance of the class.
The that should be handled by the request stream
The expected length of the contents in the stream.
if set to the stream will never explicitly be moved to disk.
Initializes a new instance of the class.
The expected length of the contents in the stream.
if set to the stream will never explicitly be moved to disk.
Initializes a new instance of the class.
The that should be handled by the request stream
The expected length of the contents in the stream.
The content length that will trigger the stream to be moved out of memory.
if set to the stream will never explicitly be moved to disk.
Begins an asynchronous read operation.
An that represents the asynchronous read, which could still be pending.
The buffer to read the data into.
The byte offset in at which to begin writing data read from the stream.
The maximum number of bytes to read.
An optional asynchronous callback, to be called when the read is complete.
A user-provided object that distinguishes this particular asynchronous read request from other requests.
Begins an asynchronous write operation.
An that represents the asynchronous write, which could still be pending.
The buffer to write data from.
The byte offset in from which to begin writing.
The maximum number of bytes to write.
An optional asynchronous callback, to be called when the write is complete.
A user-provided object that distinguishes this particular asynchronous write request from other requests.
Waits for the pending asynchronous read to complete.
The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available.
The reference to the pending asynchronous request to finish.
Ends an asynchronous write operation.
A reference to the outstanding asynchronous I/O request.
Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source.
The zero-based byte offset in at which to begin storing the data read from the current stream.
The maximum number of bytes to be read from the current stream.
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
The unsigned byte cast to an Int32, or -1 if at the end of the stream.
Sets the position within the current stream.
The new position within the current stream.
A byte offset relative to the parameter.
A value of type indicating the reference point used to obtain the new position.
Sets the length of the current stream.
The desired length of the current stream in bytes.
The stream does not support having it's length set.
This functionality is not supported by the type and will always throw .
Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
An array of bytes. This method copies bytes from to the current stream.
The zero-based byte offset in at which to begin copying bytes to the current stream.
The number of bytes to be written to the current stream.
Gets a value indicating whether the current stream supports reading.
Always returns .
Gets a value indicating whether the current stream supports seeking.
Always returns .
Gets a value that determines whether the current stream can time out.
Always returns .
Gets a value indicating whether the current stream supports writing.
Always returns .
Gets the length in bytes of the stream.
A long value representing the length of the stream in bytes.
Gets a value indicating whether the current stream is stored in memory.
if the stream is stored in memory; otherwise, .
The stream is moved to disk when either the length of the contents or expected content length exceeds the threshold specified in the constructor.
Gets or sets the position within the current stream.
The current position within the stream.
A response representing a file.
If the response contains an invalid file (not found, empty name, missing extension and so on) the status code of the response will be set to .
Size of buffer for transmitting file. Default size 4 Mb
Initializes a new instance of the for the file specified
by the parameter.
The name of the file, including path relative to the root of the application, that should be returned.
The method will be used to determine the mimetype of the file and will be used as the content-type of the response. If no match if found the content-type will be set to application/octet-stream.
Initializes a new instance of the for the file specified
by the parameter.
The name of the file, including path relative to the root of the application, that should be returned.
The method will be used to determine the mimetype of the file and will be used as the content-type of the response. If no match if found the content-type will be set to application/octet-stream.
Current context
Initializes a new instance of the for the file specified
by the parameter and the content-type specified by the parameter.
The name of the file, including path relative to the root of the application, that should be returned.
The content-type of the response.
Current context
Represents a list of "base paths" where it is safe to
serve files from.
Attempting to server a file outside of these safe paths
will fail with a 404.
Gets the filename of the file response
A string containing the name of the file.
A response representing an HTTP redirect
Initializes a new instance of the class.
Location to redirect to
Type of redirection to perform
Which type of redirect
HTTP 301 - All future requests should be to this URL
HTTP 307 - Redirect this request but allow future requests to the original URL
HTTP 303 - Redirect this request using an HTTP GET
Default implementation for building a full configured instance.
Initializes a new instance of the class.
The instance that should be assigned to the module.
An instance that should be used to create a response formatter for the module.
A instance that should be assigned to the module.
A instance that should be assigned to the module.
Builds a fully configured instance, based upon the provided .
The that should be configured.
The current request context.
A fully configured instance.
It's not safe for a module to take a dependency on the cache (cyclic dependency)
We provide an IRouteCacheProvider instead - the default implementation uses
TinyIoC'd Func based lazy factory.
It's not safe for a module to take a dependency on the cache (cyclic dependency)
We provide an instead.
It is *not* safe to call GetCache() inside a NancyModule constructor, although that shouldn't be necessary anyway.
Gets an instance of the route cache.
An instance.
Initializes a new instance of the DefaultRouteCacheProvider class.
Gets an instance of the route cache.
An instance.
Gets the name of the provider.
A containing the name of the provider.
Gets the description of the provider.
A containing the description of the provider.
Gets the object that contains the interactive diagnostics methods.
An instance of the interactive diagnostics object.
Default implementation of a route pattern matcher.
Defined the functionality that is required by a route pattern matcher.
Implement this interface if you want to support a custom route syntax.
Attempts to match a requested path with a route pattern.
The path that was requested.
The route pattern that the requested path should be attempted to be matched with.
The instance for the current request.
An instance, containing the outcome of the match.
Attempts to match a requested path with a route pattern.
The path that was requested.
The route pattern that the requested path should be attempted to be matched with.
The instance for the current request.
An instance, containing the outcome of the match.
Contains a cache of all routes registered in the system
Gets a boolean value that indicates of the cache is empty or not.
if the cache is empty, otherwise .
Caches information about all the available routes that was discovered by the bootstrapper.
Initializes a new instance of the class.
The that should be used by the cache.
The that should be used to create a context instance.
Gets a boolean value that indicates of the cache is empty or not.
if the cache is empty, otherwise .
Defines the functionality that is required by a route pattern match result.
Gets the that was active when the result was produced.
A instance.
Gets a value indicating whether or not a match was made.
if a match was made; otherwise .
The parameters that could be captured in the route.
A instance containing the captured parameters and values.
Should be empty if is .
Route that is returned when the path could be matched but it was for the wrong request method.
This is equal to sending back the 405 HTTP status code.
Initializes a new instance of the type, for the
specified , and .
The path of the route.
The HTTP method of the route.
The HTTP methods that can be used to invoke the route.
Represents the various parts of a route lambda.
Initializes a new instance of the class.
Route name
The request method of the route.
The path that the route will be invoked for.
The condition that has to be fulfilled for the route to be a valid match.
The name of the route
The condition that has to be fulfilled inorder for the route to be a valid match.
A function that evaluates the condition when a instance is passed in.
The description of what the route is for.
A containing the description of the route.
Gets or sets the metadata information for a route.
A instance.
Gets the method of the route.
A containing the method of the route.
Gets the path that the route will be invoked for.
A containing the path of the route.
Gets or set the segments, for the route, that was returned by the .
An , containing the segments for the route.
The default implementation of a route pattern matching result.
Initializes a new instance of the class.
A value indicating if the result was a match or not.
A instance containing the parameters and values that was captured in the match.
The instance of the current request.
Gets the that was active when the result was produced.
A instance.
Gets a value indicating whether or not a match was made.
if a match was made; otherwise .
The parameters that could be captured in the route.
A instance containing the captured parameters and values.
Should be empty if is .
Some simple helpers give some nice authentication syntax in the modules.
This module requires authentication
Module to enable
This module requires authentication and certain claims to be present.
Module to enable
Claim(s) required
This module requires authentication and certain claims to be present.
Module to enable
Claim(s) required
This module requires authentication and any one of certain claims to be present.
Module to enable
Claim(s) required
This module requires authentication and any one of certain claims to be present.
Module to enable
Claim(s) required
This module requires claims to be validated
Module to enable
Claims validator
This module requires https.
The that requires HTTPS.
This module requires https.
The that requires HTTPS.
if the user should be redirected to HTTPS (no port number) if the incoming request was made using HTTP, otherwise if should be returned.
This module requires https.
The that requires HTTPS.
if the user should be redirected to HTTPS if the incoming request was made using HTTP, otherwise if should be returned.
The HTTPS port number to use
Hooks to be used in a request pipeline.
Creates a hook to be used in a pipeline before a route handler to ensure that
the request was made by an authenticated user.
Hook that returns an Unauthorized response if not authenticated in,
null otherwise
Creates a hook to be used in a pipeline before a route handler to ensure
that the request was made by an authenticated user having the required claims.
Claims the authenticated user needs to have
Hook that returns an Unauthorized response if the user is not
authenticated or does not have the required claims, null otherwise
Creates a hook to be used in a pipeline before a route handler to ensure
that the request was made by an authenticated user having at least one of
the required claims.
Claims the authenticated user needs to have at least one of
Hook that returns an Unauthorized response if the user is not
authenticated or does not have at least one of the required claims, null
otherwise
Creates a hook to be used in a pipeline before a route handler to ensure
that the request was made by an authenticated user whose claims satisfy the
supplied validation function.
Validation function to be called with the authenticated
users claims
Hook that returns an Unauthorized response if the user is not
authenticated or does not pass the supplied validation function, null
otherwise
Creates a hook to be used in a pipeline before a route handler to ensure that
the request satisfies a specific test.
Test that must return true for the request to continue
Hook that returns an Unauthorized response if the test fails, null otherwise
Creates a hook to be used in a pipeline before a route handler to ensure that
the request satisfies a specific test.
Test that must return true for the request to continue
Hook that returns an Forbidden response if the test fails, null otherwise
Creates a hook to be used in a pipeline before a route handler to ensure that
the request satisfies a specific test.
HttpStatusCode to use for the response
Test that must return true for the request to continue
Hook that returns a response with a specific HttpStatusCode if the test fails, null otherwise
Creates a hook to be used in a pipeline before a route handler to ensure that
the resource is served over HTTPS
if the user should be redirected to HTTPS (no port number) if the incoming request was made using HTTP, otherwise if should be returned.
Hook that returns a RedirectResponse with the Url scheme set to HTTPS,
or a Response with a Forbidden HTTP status code if redirect is false or the method is not GET,
null otherwise
Creates a hook to be used in a pipeline before a route handler to ensure that
the resource is served over HTTPS
if the user should be redirected to HTTPS (no port number) if the incoming request was made using HTTP, otherwise if should be returned.
The HTTPS port number to use
Hook that returns a with the Url scheme set to HTTPS,
or a with a status code if redirect is false or the method is not GET,
null otherwise
Extension methods for working with IUserIdentity.
Tests if the user is authenticated.
User to be verified
True if the user is authenticated, false otherwise
Tests if the user has a required claim.
User to be verified
Claim the user needs to have
True if the user has the required claim, false otherwise
Tests if the user has all of the required claims.
User to be verified
Claims the user needs to have
True if the user has all of the required claims, false otherwise
Tests if the user has at least one of the required claims.
User to be verified
Claims the user needs to have at least one of
True if the user has at least one of the required claims, false otherwise
Tests if the user has claims that satisfy the supplied validation function.
User to be verified
Validation function to be called with the authenticated
users claims
True if the user does pass the supplied validation function, false otherwise
Cookie based session storage
Allows setting of the serializer for session object storage
Using the specified serializer
Serializer to use
Initializes a new instance of the class.
The encryption provider.
The hmac provider
Session object serializer to use
Initializes a new instance of the class.
Cookie based sessions configuration.
Initialise and add cookie based session hooks to the application pipeline
Application pipelines
Cookie based sessions configuration.
Formatter selector for choosing a non-default serializer
Initialise and add cookie based session hooks to the application pipeline
Application pipelines
Cryptography configuration
Formatter selector for choosing a non-default serializer
Initialise and add cookie based session hooks to the application pipeline with the default encryption provider.
Application pipelines
Formatter selector for choosing a non-default serializer
Using the specified serializer
Formatter to use
Save the session into the response
Session to save
Response to save into
Loads the session from the request
Request to load from
ISession containing the load session values
Saves the request session into the response
Nancy context
Session store
Loads the request session
Nancy context
Session store
Always returns null
Gets the cookie name that the session is stored in
Cookie name
Default encryption provider using Rijndael
Creates a new instance of the RijndaelEncryptionProvider class
Key generator to use to generate the key and iv
Encrypt data
Data to encrypt
Encrypted string
Decrypt string
Data to decrypt
Decrypted string
De/Serialisation for cookie objects
Serialize an object
Source object
Serialised object string
Deserialize an object string
Source object string
Deserialized object
Serialize an object
Source object
Serialised object string
Deserialize an object string
Source object string
Deserialized object
Defines the interface for a session
Deletes the session and all associated information
Deletes the specific key from the session
The number of session values
Retrieves the value from the session
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
1
Returns an enumerator that iterates through a collection.
An object that can be used to iterate through the collection.
2
Deletes the session and all associated information
Deletes the specific key from the session
The number of session values
Retrieves the value from the session
Session implementation
Deletes all items
Delete an item with the given key
Key to delete
Returns an enumerator that iterates through a collection.
An object that can be used to iterate through the collection.
2
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
1
Gets the number of items stored
Gets or sets values
The key whos value to get or set
The value, or null or the key didn't exist
Gets whether the session has changed
A decorator stream that sits on top of an existing stream and appears as a unique stream.
Initializes a new instance of the class.
The stream to create the sub-stream ontop of.
The start offset on the parent stream where the sub-stream should begin.
The end offset on the parent stream where the sub-stream should end.
When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
In the type this method is implemented as no-op.
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source.
The zero-based byte offset in at which to begin storing the data read from the current stream.
The maximum number of bytes to be read from the current stream.
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
The unsigned byte cast to an Int32, or -1 if at the end of the stream.
When overridden in a derived class, sets the position within the current stream.
The new position within the current stream.
A byte offset relative to the parameter.
A value of type indicating the reference point used to obtain the new position.
When overridden in a derived class, sets the length of the current stream.
The desired length of the current stream in bytes.
This will always throw a for the type.
When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
An array of bytes. This method copies bytes from to the current stream.
The zero-based byte offset in at which to begin copying bytes to the current stream.
The number of bytes to be written to the current stream.
This will always throw a for the type.
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
if the stream supports reading; otherwise, .
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
if the stream supports seeking; otherwise, .
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
if the stream supports writing; otherwise, .
When overridden in a derived class, gets the length in bytes of the stream.
A long value representing the length of the stream in bytes.
A class derived from Stream does not support seeking. Methods were called after the stream was closed.
When overridden in a derived class, gets or sets the position within the current stream.
The current position within the stream.
An I/O error occurs. The stream does not support seeking. Methods were called after the stream was closed. 1
Gets a generic method from a type given the method name, binding flags, generic types and parameter types
Source type
Binding flags
Name of the method
Generic types to use to make the method generic
Method parameters
MethodInfo or null if no matches found
Name/Value pairs for specifying "user" parameters when resolving
Attempt to resolve type, even if the type isn't registered.
Registered types/options will always take precedence.
Fail resolution if type not explicitly registered
Attempt to resolve unregistered type if requested type is generic
and no registration exists for the specific generic parameters used.
Registered types/options will always take precedence.
Resolution settings
Gets the default options (attempt resolution of unregistered types, fail on named resolution if name not found)
Preconfigured option for attempting resolution of unregistered types and failing on named resolution if name not found
Preconfigured option for failing on resolving unregistered types and on named resolution if name not found
Preconfigured option for failing on resolving unregistered types, but attempting unnamed resolution if name not found
Attempt to automatically register all non-generic classes and interfaces in the current app domain.
If more than one class implements an interface then only one implementation will be registered
although no error will be thrown.
Attempt to automatically register all non-generic classes and interfaces in the current app domain.
Types will only be registered if they pass the supplied registration predicate.
If more than one class implements an interface then only one implementation will be registered
although no error will be thrown.
Predicate to determine if a particular type should be registered
Attempt to automatically register all non-generic classes and interfaces in the current app domain.
What action to take when encountering duplicate implementations of an interface/base class.
Attempt to automatically register all non-generic classes and interfaces in the current app domain.
Types will only be registered if they pass the supplied registration predicate.
What action to take when encountering duplicate implementations of an interface/base class.
Predicate to determine if a particular type should be registered
Attempt to automatically register all non-generic classes and interfaces in the specified assemblies
If more than one class implements an interface then only one implementation will be registered
although no error will be thrown.
Assemblies to process
Attempt to automatically register all non-generic classes and interfaces in the specified assemblies
Types will only be registered if they pass the supplied registration predicate.
If more than one class implements an interface then only one implementation will be registered
although no error will be thrown.
Assemblies to process
Predicate to determine if a particular type should be registered
Attempt to automatically register all non-generic classes and interfaces in the specified assemblies
Assemblies to process
What action to take when encountering duplicate implementations of an interface/base class.
Attempt to automatically register all non-generic classes and interfaces in the specified assemblies
Types will only be registered if they pass the supplied registration predicate.
Assemblies to process
What action to take when encountering duplicate implementations of an interface/base class.
Predicate to determine if a particular type should be registered
Creates/replaces a container class registration with default options.
Type to register
RegisterOptions for fluent API
Creates/replaces a named container class registration with default options.
Type to register
Name of registration
RegisterOptions for fluent API
Creates/replaces a container class registration with a given implementation and default options.
Type to register
Type to instantiate that implements RegisterType
RegisterOptions for fluent API
Creates/replaces a named container class registration with a given implementation and default options.
Type to register
Type to instantiate that implements RegisterType
Name of registration
RegisterOptions for fluent API
Creates/replaces a container class registration with a specific, strong referenced, instance.
Type to register
Instance of RegisterType to register
RegisterOptions for fluent API
Creates/replaces a named container class registration with a specific, strong referenced, instance.
Type to register
Instance of RegisterType to register
Name of registration
RegisterOptions for fluent API
Creates/replaces a container class registration with a specific, strong referenced, instance.
Type to register
Type of instance to register that implements RegisterType
Instance of RegisterImplementation to register
RegisterOptions for fluent API
Creates/replaces a named container class registration with a specific, strong referenced, instance.
Type to register
Type of instance to register that implements RegisterType
Instance of RegisterImplementation to register
Name of registration
RegisterOptions for fluent API
Creates/replaces a container class registration with a user specified factory
Type to register
Factory/lambda that returns an instance of RegisterType
RegisterOptions for fluent API
Creates/replaces a container class registration with a user specified factory
Type to register
Factory/lambda that returns an instance of RegisterType
Name of registation
RegisterOptions for fluent API
Creates/replaces a container class registration with default options.
Type to register
RegisterOptions for fluent API
Creates/replaces a named container class registration with default options.
Type to register
Name of registration
RegisterOptions for fluent API
Creates/replaces a container class registration with a given implementation and default options.
Type to register
Type to instantiate that implements RegisterType
RegisterOptions for fluent API
Creates/replaces a named container class registration with a given implementation and default options.
Type to register
Type to instantiate that implements RegisterType
Name of registration
RegisterOptions for fluent API
Creates/replaces a container class registration with a specific, strong referenced, instance.
Type to register
Instance of RegisterType to register
RegisterOptions for fluent API
Creates/replaces a named container class registration with a specific, strong referenced, instance.
Type to register
Instance of RegisterType to register
Name of registration
RegisterOptions for fluent API
Creates/replaces a container class registration with a specific, strong referenced, instance.
Type to register
Type of instance to register that implements RegisterType
Instance of RegisterImplementation to register
RegisterOptions for fluent API
Creates/replaces a named container class registration with a specific, strong referenced, instance.
Type to register
Type of instance to register that implements RegisterType
Instance of RegisterImplementation to register
Name of registration
RegisterOptions for fluent API
Creates/replaces a container class registration with a user specified factory
Type to register
Factory/lambda that returns an instance of RegisterType
RegisterOptions for fluent API
Creates/replaces a named container class registration with a user specified factory
Type to register
Factory/lambda that returns an instance of RegisterType
Name of registation
RegisterOptions for fluent API
Register multiple implementations of a type.
Internally this registers each implementation using the full name of the class as its registration name.
Type that each implementation implements
Types that implement RegisterType
MultiRegisterOptions for the fluent API
Register multiple implementations of a type.
Internally this registers each implementation using the full name of the class as its registration name.
Type that each implementation implements
Types that implement RegisterType
MultiRegisterOptions for the fluent API
Attempts to resolve a type using default options.
Type to resolve
Instance of type
Unable to resolve the type.
Attempts to resolve a type using specified options.
Type to resolve
Resolution options
Instance of type
Unable to resolve the type.
Attempts to resolve a type using default options and the supplied name.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
Name of registration
Instance of type
Unable to resolve the type.
Attempts to resolve a type using supplied options and name.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
Name of registration
Resolution options
Instance of type
Unable to resolve the type.
Attempts to resolve a type using default options and the supplied constructor parameters.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
User specified constructor parameters
Instance of type
Unable to resolve the type.
Attempts to resolve a type using specified options and the supplied constructor parameters.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
User specified constructor parameters
Resolution options
Instance of type
Unable to resolve the type.
Attempts to resolve a type using default options and the supplied constructor parameters and name.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
User specified constructor parameters
Name of registration
Instance of type
Unable to resolve the type.
Attempts to resolve a named type using specified options and the supplied constructor parameters.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
Name of registration
User specified constructor parameters
Resolution options
Instance of type
Unable to resolve the type.
Attempts to resolve a type using default options.
Type to resolve
Instance of type
Unable to resolve the type.
Attempts to resolve a type using specified options.
Type to resolve
Resolution options
Instance of type
Unable to resolve the type.
Attempts to resolve a type using default options and the supplied name.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
Name of registration
Instance of type
Unable to resolve the type.
Attempts to resolve a type using supplied options and name.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
Name of registration
Resolution options
Instance of type
Unable to resolve the type.
Attempts to resolve a type using default options and the supplied constructor parameters.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
User specified constructor parameters
Instance of type
Unable to resolve the type.
Attempts to resolve a type using specified options and the supplied constructor parameters.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
User specified constructor parameters
Resolution options
Instance of type
Unable to resolve the type.
Attempts to resolve a type using default options and the supplied constructor parameters and name.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
User specified constructor parameters
Name of registration
Instance of type
Unable to resolve the type.
Attempts to resolve a named type using specified options and the supplied constructor parameters.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Type to resolve
Name of registration
User specified constructor parameters
Resolution options
Instance of type
Unable to resolve the type.
Attempts to predict whether a given type can be resolved with default options.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
Name of registration
Bool indicating whether the type can be resolved
Attempts to predict whether a given named type can be resolved with default options.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
Bool indicating whether the type can be resolved
Attempts to predict whether a given type can be resolved with the specified options.
Note: Resolution may still fail if user defined factory registrations fail to construct objects when called.
Type to resolve
Name of registration
Resolution options
Bool indicating whether the type can be resolved
Attempts to predict whether a given named type can be resolved with the specified options.
Note: Resolution may still fail if user defined factory registrations fail to construct objects when called.
Type to resolve
Name of registration
Resolution options
Bool indicating whether the type can be resolved
Attempts to predict whether a given type can be resolved with the supplied constructor parameters and default options.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
User supplied named parameter overloads
Bool indicating whether the type can be resolved
Attempts to predict whether a given named type can be resolved with the supplied constructor parameters and default options.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
Name of registration
User supplied named parameter overloads
Bool indicating whether the type can be resolved
Attempts to predict whether a given type can be resolved with the supplied constructor parameters options.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
User supplied named parameter overloads
Resolution options
Bool indicating whether the type can be resolved
Attempts to predict whether a given named type can be resolved with the supplied constructor parameters options.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
Name of registration
User supplied named parameter overloads
Resolution options
Bool indicating whether the type can be resolved
Attempts to predict whether a given type can be resolved with default options.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
Name of registration
Bool indicating whether the type can be resolved
Attempts to predict whether a given named type can be resolved with default options.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
Bool indicating whether the type can be resolved
Attempts to predict whether a given type can be resolved with the specified options.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
Name of registration
Resolution options
Bool indicating whether the type can be resolved
Attempts to predict whether a given named type can be resolved with the specified options.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
Name of registration
Resolution options
Bool indicating whether the type can be resolved
Attempts to predict whether a given type can be resolved with the supplied constructor parameters and default options.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
User supplied named parameter overloads
Bool indicating whether the type can be resolved
Attempts to predict whether a given named type can be resolved with the supplied constructor parameters and default options.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
Name of registration
User supplied named parameter overloads
Bool indicating whether the type can be resolved
Attempts to predict whether a given type can be resolved with the supplied constructor parameters options.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Note: Resolution may still fail if user defined factory registrations fail to construct objects when called.
Type to resolve
User supplied named parameter overloads
Resolution options
Bool indicating whether the type can be resolved
Attempts to predict whether a given named type can be resolved with the supplied constructor parameters options.
Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists).
All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail.
Note: Resolution may still fail if user defined factory registations fail to construct objects when called.
Type to resolve
Name of registration
User supplied named parameter overloads
Resolution options
Bool indicating whether the type can be resolved
Attemps to resolve a type using the default options
Type to resolve
Resolved type or default if resolve fails
True if resolved sucessfully, false otherwise
Attemps to resolve a type using the given options
Type to resolve
Resolution options
Resolved type or default if resolve fails
True if resolved sucessfully, false otherwise
Attemps to resolve a type using the default options and given name
Type to resolve
Name of registration
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the given options and name
Type to resolve
Name of registration
Resolution options
Resolved type or default if resolve fails
True if resolved sucessfully, false otherwise
Attemps to resolve a type using the default options and supplied constructor parameters
Type to resolve
User specified constructor parameters
Resolved type or default if resolve fails
True if resolved sucessfully, false otherwise
Attemps to resolve a type using the default options and supplied name and constructor parameters
Type to resolve
Name of registration
User specified constructor parameters
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the supplied options and constructor parameters
Type to resolve
Name of registration
User specified constructor parameters
Resolution options
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the supplied name, options and constructor parameters
Type to resolve
Name of registration
User specified constructor parameters
Resolution options
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the default options
Type to resolve
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the given options
Type to resolve
Resolution options
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the default options and given name
Type to resolve
Name of registration
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the given options and name
Type to resolve
Name of registration
Resolution options
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the default options and supplied constructor parameters
Type to resolve
User specified constructor parameters
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the default options and supplied name and constructor parameters
Type to resolve
Name of registration
User specified constructor parameters
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the supplied options and constructor parameters
Type to resolve
Name of registration
User specified constructor parameters
Resolution options
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Attemps to resolve a type using the supplied name, options and constructor parameters
Type to resolve
Name of registration
User specified constructor parameters
Resolution options
Resolved type or default if resolve fails
True if resolved successfully, false otherwise
Returns all registrations of a type
Type to resolveAll
Whether to include un-named (default) registrations
IEnumerable
Returns all registrations of a type, both named and unnamed
Type to resolveAll
IEnumerable
Returns all registrations of a type
Type to resolveAll
Whether to include un-named (default) registrations
IEnumerable
Returns all registrations of a type, both named and unnamed
Type to resolveAll
Whether to include un-named (default) registrations
IEnumerable
Attempts to resolve all public property dependencies on the given object.
Object to "build up"
Attempts to resolve all public property dependencies on the given object using the given resolve options.
Object to "build up"
Resolve options to use
Lazy created Singleton instance of the container for simple scenarios
Registration options for "fluent" API
Make registration a singleton (single instance) if possible
RegisterOptions
Make registration multi-instance if possible
RegisterOptions
Make registration hold a weak reference if possible
RegisterOptions
Make registration hold a strong reference if possible
RegisterOptions
Switches to a custom lifetime manager factory if possible.
Usually used for RegisterOptions "To*" extension methods such as the ASP.Net per-request one.
RegisterOptions instance
Custom lifetime manager
Error string to display if switch fails
RegisterOptions
Registration options for "fluent" API when registering multiple implementations
Initializes a new instance of the MultiRegisterOptions class.
Registration options
Make registration a singleton (single instance) if possible
RegisterOptions
Make registration multi-instance if possible
MultiRegisterOptions
Switches to a custom lifetime manager factory if possible.
Usually used for RegisterOptions "To*" extension methods such as the ASP.Net per-request one.
MultiRegisterOptions instance
Custom lifetime manager
Error string to display if switch fails
MultiRegisterOptions
Provides custom lifetime management for ASP.Net per-request lifetimes etc.
Gets the stored object if it exists, or null if not
Object instance or null
Store the object
Object to store
Release the object
Create the type
Type user requested to be resolved
Container that requested the creation
Any user parameters passed
Whether to assume this factory successfully constructs its objects
Generally set to true for delegate style factories as CanResolve cannot delve
into the delegates they contain.
The type the factory instantiates
Constructor to use, if specified
IObjectFactory that creates new instances of types for each resolution
IObjectFactory that invokes a specified delegate to construct the object
IObjectFactory that invokes a specified delegate to construct the object
Holds the delegate using a weak reference
Stores an particular instance to return for a type
Stores an particular instance to return for a type
Stores the instance with a weak reference
A factory that lazy instantiates a type and always returns the same instance
A factory that offloads lifetime to an external lifetime provider
Defines the functionality of an engine that can handle Nancy s.
Handles an incoming async.
An instance, containing the information about the current request.
Delegate to call before the request is processed
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
The task object representing the asynchronous operation.
Factory for creating an instance for a incoming request.
An instance.
Encapsulates HTTP-request information to an Nancy application.
Initializes a new instance of the class.
The HTTP data transfer method used by the client.
The path of the requested resource, relative to the "Nancy root". This should not include the scheme, host name, or query portion of the URI.
The HTTP protocol that was used by the client.
Initializes a new instance of the class.
The HTTP data transfer method used by the client.
The of the requested resource
The headers that was passed in by the client.
The that represents the incoming HTTP body.
The client's IP address
The client's certificate when present.
The HTTP protocol version.
Gets the cookie data from the request header if it exists
Cookies dictionary
Gets the certificate sent by the client.
Gets the HTTP protocol version.
Gets the IP address of the client
Gets or sets the HTTP data transfer method used by the client.
The method.
Gets the url
Gets the request path, relative to the base path.
Used for route matching etc.
Gets the query string data of the requested resource.
A instance, containing the key/value pairs of query string data.
Gets a that can be used to read the incoming HTTP body
A object representing the incoming HTTP body.
Gets the request cookies.
Gets the current session.
Gets a collection of files sent by the client-
An instance, containing an instance for each uploaded file.
Gets the form data of the request.
A instance, containing the key/value pairs of form data.
Currently Nancy will only parse form data sent using the application/x-www-url-encoded mime-type.
Gets the HTTP headers sent by the client.
An containing the name and values of the headers.
The values are stored in an of string to be compliant with multi-value headers.
Default engine for handling Nancy s.
Initializes a new instance of the class.
An instance that will be used to resolve a route, from the modules, that matches the incoming .
A factory for creating contexts
Error handlers
The request tracing instance.
The provider to use for serving static content
The response negotiator.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Factory for creating an instance for a incoming request.
An instance.
Returns a route that matches the request
Gets the route, and the corresponding parameter dictionary from the URL
Current context
A containing the resolved route information.
Route that is returned when the path could not be matched.
This is equal to sending back the 404 HTTP status code.
Initializes a new instance of the type, for the
specified and .
The HTTP method of the route.
The path of the route.
A dictionary that supports dynamic access.
Creates a dynamic dictionary from an instance.
An instance, that the dynamic dictionary should be created from.
An instance.
Provides the implementation for operations that set member values. Classes derived from the class can override this method to specify dynamic behavior for operations such as setting a value for a property.
true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.)
Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member to which the value is being assigned. For example, for the statement sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive.The value to set to the member. For example, for sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the class, the is "Test".
Provides the implementation for operations that get member values. Classes derived from the class can override this method to specify dynamic behavior for operations such as getting a value for a property.
true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a run-time exception is thrown.)
Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member on which the dynamic operation is performed. For example, for the Console.WriteLine(sampleObject.SampleProperty) statement, where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive.The result of the get operation. For example, if the method is called for a property, you can assign the property value to .
Returns the enumeration of all dynamic member names.
A that contains dynamic member names.
Returns the enumeration of all dynamic member names.
A that contains dynamic member names.
Returns the enumeration of all dynamic member names.
A that contains dynamic member names.
Indicates whether the current is equal to another object of the same type.
if the current instance is equal to the parameter; otherwise, .
An instance to compare with this instance.
Determines whether the specified is equal to this instance.
The to compare with this instance.
if the specified is equal to this instance; otherwise, .
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
Returns a hash code for this .
A hash code for this , suitable for use in hashing algorithms and data structures like a hash table.
Adds an element with the provided key and value to the .
The object to use as the key of the element to add.
The object to use as the value of the element to add.
Adds an item to the .
The object to add to the .
Determines whether the contains an element with the specified key.
if the contains an element with the key; otherwise, .
The key to locate in the .
Gets the value associated with the specified key.
if the contains an element with the specified key; otherwise, .
The key whose value to get.
When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the parameter. This parameter is passed uninitialized.
Removes all items from the .
Determines whether the contains a specific value.
if is found in the ; otherwise, .
The object to locate in the .
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from the . The must have zero-based indexing.
The zero-based index in at which copying begins.
Removes the element with the specified key from the .
if the element is successfully removed; otherwise, .
The key of the element to remove.
Removes the first occurrence of a specific object from the .
if was successfully removed from the ; otherwise, .
The object to remove from the .
Gets a typed Dictionary of from
Gets a typed Dictionary of from
Returns an empty dynamic dictionary.
A instance.
Gets or sets the with the specified name.
A instance containing a value.
Gets an containing the keys of the .
An containing the keys of the .
Gets the number of elements contained in the .
The number of elements contained in the .
Gets a value indicating whether the is read-only.
Always returns .
Gets an containing the values in the .
An containing the values in the .
Default implementation of the interface.
Initializes a new instance of the class, using
the provided , ,
and .
A instance.
A instance.
A instance.
A instance.
Gets the route, and the corresponding parameter dictionary from the URL
Current context
A containing the resolved route information.
Thrown when multiple instances describe the exact same view.
Initializes a new instance of the class.
Initializes a new instance of the class.
The message that should be displayed with the exception.
The default implementation for how views are resolved and rendered by Nancy.
Defines the functionality used by a to render a view to the response.
Renders the view with the name and model defined by the and parameters.
The name of the view to render.
The module path of the module that is rendering the view.
A instance, containing information about the context for which the view is being rendered.
A response.
Initializes a new instance of the class.
An instance that should be used to resolve the location of a view.
An instance containing the instances that should be able to be used to render a view
A instance that should be used to create an when a view is rendered.
An instance that should be used to resolve all possible view locations
An instance.
Renders the view with the name and model defined by the and parameters.
The name of the view to render.
The model that should be passed into the view.
A instance, containing information about the context for which the view is being rendered.
A delegate that can be invoked with the that the view should be rendered to.
The default implementation for how views are located by Nancy.
Defines the functionality for locating the requested view.
Gets the location of the view defined by the parameter.
Name of the view to locate.
The instance for the current request.
A instance if the view could be located; otherwise .
Gets all the views that are currently discovered
Note: this is *not* the recommended way to deal with the view locator
as it doesn't allow for runtime discovery of views with the
settings.
A collection of instances
Gets the location of the view defined by the parameter.
Name of the view to locate.
The instance for the current request.
A instance if the view could be located; otherwise .
Gets all the views that are currently discovered
Note: this is *not* the recommended way to deal with the view locator
as it doesn't allow for runtime discovery of views with the
settings.
A collection of instances
Default implementation on how views are resolved by Nancy.
Initializes a new instance of the class.
The view locator that should be used to locate views.
The conventions that the view resolver should use to figure out where to look for views.
Locates a view based on the provided information.
The name of the view to locate.
The model that will be used with the view.
A instance, containing information about the context for which the view is being located.
A instance if the view could be found, otherwise .
View location result for file system based views.
Supports detecting if the contents have changed since it
was last read.
Contains the result of an attempt to locate a view.
Initializes a new instance of the class.
Initializes a new instance of the class.
The location of where the view was found.
The name of the view.
The file extension of the located view.
A that can be used to read the contents of the located view.
Gets a value indicating whether the current item is stale
True if stale, false otherwise
Indicates whether the current object is equal to another object of the same type.
if the current object is equal to the parameter; otherwise, .
An to compare with this instance.
Determines whether the specified is equal to the current .
if the specified is equal to the current ; otherwise, .
The to compare with the current .
Serves as a hash function for a particular type.
A hash code for the current .
Gets a function that produces a reader for retrieving the contents of the view.
A instance that can be used to produce a reader for retrieving the contents of the view.
Gets the extension of the view that was located.
A containing the extension of the view that was located.
The extension should not contain a leading dot.
Gets the location of where the view was found.
A containing the location of the view.
Gets the full name of the view that was found
A containing the name of the view.
Initializes a new instance of the class.
The location of where the view was found.
The name of the view.
The file extension of the located view.
A that can be used to read the contents of the located view.
Full filename of the file
An instance that should be used when retrieving view information from the file system.
Gets a value indicating whether the current item is stale
True if stale, false otherwise
Wraps the real contents delegate to set the last modified date first
TextReader to read the file
Defines the functionality that a view engine must support to be integrated into Nancy.
Initialise the view engine (if necessary)
Startup context
Renders the view.
A instance, containing information on how to get the view template.
The model that should be passed into the view
A response
Gets the extensions file extensions that are supported by the view engine.
An instance containing the extensions.
The extensions should not have a leading dot in the name.
Contains the functionality for locating a view that has been embedded into an assembly resource.
User-configured root namespaces for assemblies.
A list of assemblies to ignore when scanning for embedded views.
Initializes a new instance of the class.
Initializes a new instance of the class.
An instance that should be used when extracting embedded views.
An instance that should be used to determine which assemblies to scan for embedded views.
Returns an instance for all the views that could be located by the provider.
An instance, containing the view engine file extensions that is supported by the running instance of Nancy.
An instance, containing instances for the located views.
If no views could be located, this method should return an empty enumerable, never .
Returns an instance for all the views matching the viewName that could be located by the provider.
An instance, containing the view engine file extensions that is supported by the running instance of Nancy.
The name of the view to try and find
An instance, containing instances for the located views.
If no views could be located, this method should return an empty enumerable, never .
Matches and modifies the content of a rendered SuperSimpleViewEngine view.
Invokes the matcher on the content of the rendered view.
The content of the rendered view.
The model that was passed to the view.
The host.
The modified version of the view.
Provides the view engine with utility functions for
encoding, locating partial view templates etc.
Html "safe" encode a string
Input string
Encoded string
Get the contents of a template
Name/location of the template
Model to use to locate the template via conventions
Contents of the template, or null if not found
Gets a uri string for a named route
Named route name
Parameters to use to expand the uri string
Expanded uri string, or null if not found
Expands a path to include any base paths
Path to expand
Expanded path
Get the anti forgery token form element
String containing the form element
Context object of the host application.
An instance of the context object from the host.
Initializes a new instance of the class.
The render context.
Html "safe" encode a string
Input string
Encoded string
Get the contents of a template
Name/location of the template
Model to use to locate the template via conventions
Contents of the template, or null if not found
Gets a uri string for a named route
Named route name
Parameters to use to expand the uri string
Expanded uri string, or null if not found
Expands a path to include any base paths
Path to expand
Expanded path
Get the anti forgery token form element
String containing the form element
Context object of the host application.
An instance of the context object from the host.
A super-simple view engine
Compiled Regex for viewbag substitutions
Compiled Regex for single substitutions
Compiled Regex for context subsituations
Compiled Regex for each blocks
Compiled Regex for each block current substitutions
Compiled Regex for if blocks
Compiled regex for partial blocks
Compiled RegEx for section block declarations
Compiled RegEx for section block contents
Compiled RegEx for master page declaration
Compiled RegEx for path expansion
Compiled RegEx for path expansion in attribute values
Compiled RegEx for the CSRF anti forgery token
View engine transform processors
View engine extensions
Initializes a new instance of the class.
Initializes a new instance of the class, using
the provided extensions.
The matchers to use with the engine.
Renders a template
The template to render.
The model to user for rendering.
The view engine host
A string containing the expanded template.
Gets a property value from the given model.
Anonymous types, standard types and ExpandoObject are supported.
Arbitrary dynamics (implementing IDynamicMetaObjectProvider) are not, unless
they also implement IDictionary string, object for accessing properties.
The model.
The property name to evaluate.
Tuple - Item1 being a bool for whether the evaluation was successful, Item2 being the value.
Model type is not supported.
A property extractor for standard types.
The model.
The property name.
Tuple - Item1 being a bool for whether the evaluation was successful, Item2 being the value.
A property extractor designed for ExpandoObject, but also for any
type that implements IDictionary string object for accessing its
properties.
The model.
The property name.
Tuple - Item1 being a bool for whether the evaluation was successful, Item2 being the value.
Gets an IEnumerable of capture group values
The match to use.
Group name containing the capture group.
IEnumerable of capture group values as strings.
Gets a property value from a collection of nested parameter names
The model containing properties.
A collection of nested parameters (e.g. User, Name
Tuple - Item1 being a bool for whether the evaluation was successful, Item2 being the value.
Gets the predicate result for an If or IfNot block
The item to evaluate
Property list to evaluate
Whether to check for null, rather than straight boolean
Bool representing the predicate result
Returns the predicate result if the substitionObject is a valid bool
The substitution object.
Bool value of the substitutionObject, or false if unable to cast.
Returns the predicate result if the substitionObject is a valid ICollection
The substitution object.
Bool value of the whether the ICollection has items, or false if unable to cast.
Performs single @ViewBag.PropertyName substitutions.
The template.
This parameter is not used, the model is based on the "host.Context.ViewBag".
View engine host
Template with @ViewBag.PropertyName blocks expanded.
Performs single @Model.PropertyName substitutions.
The template.
The model.
View engine host
Template with @Model.PropertyName blocks expanded.
Performs single @Context.PropertyName substitutions.
The template.
The model.
View engine host
Template with @Context.PropertyName blocks expanded.
Performs @Each.PropertyName substitutions
The template.
The model.
View engine host
Template with @Each.PropertyName blocks expanded.
Expand a @Current match inside an @Each iterator
Contents of the @Each block
Current item from the @Each enumerable
View engine host
String result of the expansion of the @Each.
Performs @If.PropertyName and @IfNot.PropertyName substitutions
The template.
The model.
View engine host
Template with @If.PropertyName @IfNot.PropertyName blocks removed/expanded.
Perform path expansion substitutions
The template.
The model.
View engine host
Template with paths expanded
Perform CSRF anti forgery token expansions
The template.
The model.
View engine host
Template with anti forgery tokens expanded
Perform @Partial partial view expansion
The template.
The model.
View engine host
Template with partials expanded
Invokes the master page rendering with current sections if necessary
The template.
The model.
View engine host
Template with master page applied and sections substituted
Renders a master page - does a normal render then replaces any section tags with sections passed in
The master page template
Dictionary of section contents
The model.
View engine host
Template with the master page applied and sections substituted
Gets the master page name, if one is specified
The template
Master page name or String.Empty
Performs application registrations for the SuperSimpleViewEngine.
Gets the type registrations to register for this startup task
Gets the collection registrations to register for this startup task
Gets the instance registrations to register for this startup task
Nancy IViewEngine wrapper for the super simple view engine
Extensions that the view engine supports
The engine itself
Initializes a new instance of the class, using
the provided extensions.
The matchers to use with the engine.
Initialise the view engine (if necessary)
Startup context
Renders the view.
A instance, containing information on how to get the view template.
The model that should be passed into the view
An instance.
A response
Gets the extensions file extensions that are supported by the view engine.
An instance containing the extensions.
The extensions should not have a leading dot in the name.
Calls the initialize method on all implementations, at application startup.
Initializes a new instance of the class, with the
provided , and .
The available view engines.
The view cache.
The view locator.
Perform any initialisation tasks
Application pipelines
Context passed to each view engine on startup
Gets the Nancy view cache - can be used to precompile views at startup
if necessary.
Gets the Nancy view locator
The context for which a view is being located.
The module path of the that is locating a view.
A containing the module path.
The name of the that is locating a view.
A containing the name of the module.
The request/response context
Exception that is thrown when a view could not be located.
Initializes a new instance of the .
The name of the view that was being located.
List of available view extensions that can be rendered by the available view engines.
The locations that were inspected for the view.
An instance.
Initializes a new instance of the
A message describing the problem
Gets a message that describes the current exception.
The error message that explains the reason for the exception, or an empty string("").
An exception that indicates the view could not be rendered
Create an instance of
A description of the rendering problem
Create an instance of
A description of the rendering problem
The exception that is the cause of the current exception.
Helper class for rendering a view from a route handler.
Initializes a new instance of the class.
The instance that is rendering the view.
Renders the view with its name resolved from the model type, and model defined by the parameter.
The model that should be passed into the view.
A delegate that can be invoked with the that the view should be rendered to.
The view name is model.GetType().Name with any Model suffix removed.
Renders the view with the name defined by the parameter.
The name of the view to render.
A delegate that can be invoked with the that the view should be rendered to.
The extension in the view name is optional. If it is omitted, then Nancy will try to resolve which of the available engines that should be used to render the view.
Renders the view with the name and model defined by the and parameters.
The name of the view to render.
The model that should be passed into the view.
A delegate that can be invoked with the that the view should be rendered to.
The extension in the view name is optional. If it is omitted, then Nancy will try to resolve which of the available engines that should be used to render the view.
Gets or sets whether character encoding should be enabled, or not, for XML responses.
The default value is
Gets the default encoding for XML responses.
The default value is