Skip to main content

Crate nestforge

Crate nestforge 

Source

Re-exports§

pub use serde_json;

Modules§

prelude

Macros§

auth_guard
guard
impl_identifiable
interceptor
middleware
request_decorator
role_guard

Structs§

AuthIdentity
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Authentication Identity
AuthUser
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; AuthUser Extractor
BearerToken
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; BearerToken Extractor
Body
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Wrapper for extracting the JSON request body.
Container
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; The Dependency Injection (DI) Container.
Cookies
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Extractor for HTTP cookies.
Decorated
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
DynamicModuleBuilder
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
Headers
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Extractor for HTTP headers.
HttpException
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; HttpException
InMemoryStore
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; In-Memory Store
InitializedModule
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
Inject
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
MiddlewareConsumer
A builder for configuring middleware application.
MiddlewareRoute
A definition of a route (path + method) for middleware targeting.
ModuleGraphEntry
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
ModuleGraphReport
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
ModuleRef
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
NestForgeFactory
The main entry point for creating a NestForge application.
OpenApiSchemaComponent
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
OptionalAuthUser
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; OptionalAuthUser Extractor
Param
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Wrapper for extracting route parameters.
PipedBody
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
PipedParam
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
PipedQuery
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
Provider
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Provider Helper Struct
Query
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Wrapper for extracting query parameters.
RequestContext
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Context available to all guards, interceptors, and pipes in the request lifecycle.
RequestId
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; RequestId
RequireAuthenticationGuard
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; A built-in guard that ensures the user is authenticated.
ResourceService
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
ResponseEnvelope
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; ResponseEnvelope
RoleRequirementsGuard
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; A built-in guard that checks if the authenticated user has specific roles.
RouteBuilder
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
RouteDocumentation
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
RouteResponseDocumentation
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
Serialized
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Serialized Wrapper
ValidatedBody
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; A wrapper that validates the request body.
ValidationErrors
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
ValidationIssue
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};

Enums§

ContainerError
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
ResourceError
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};

Traits§

ControllerBasePath
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Metadata implemented by the #[controller("/path")] attribute macro. It defines the base path where all routes within the controller will live.
ControllerDefinition
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; A ControllerDefinition provides the structure for NestForge to build an Axum router.
DocumentedController
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
ExceptionFilter
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; A filter that catches exceptions thrown during request processing.
Guard
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; A guard determines whether a request should be allowed to proceed.
Identifiable
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Identifiable Trait
Injectable
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Injectable is the core trait of NestForge’s dependency injection system.
Interceptor
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; An interceptor wraps the request/response cycle.
IntoInjectableResult
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
ModuleDefinition
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; ModuleDefinition is the contract for defining a NestForge module.
NestMiddleware
Trait for defining custom middleware.
OpenApiSchema
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
OptionHttpExt
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
Pipe
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Pipe Transform Trait
RegisterProvider
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; RegisterProvider Trait
RequestDecorator
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Request Decorator Trait
ResponseSerializer
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; ResponseSerializer Trait
ResultHttpExt
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
Validate
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};

Functions§

collect_module_graph
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
collect_module_route_docs
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
framework_log
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
framework_log_event
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
initialize_module_graph
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
openapi_array_schema_for
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
openapi_nullable_schema_for
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
openapi_schema_components_for
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
openapi_schema_for
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
register_injectable
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
register_provider
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; Helper function to register a provider into a container.

Type Aliases§

ApiEnvelopeResult
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; A helper type for returning Result<ResponseEnvelope<T>, HttpException>.
ApiResult
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
ApiSerializedResult
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container}; A helper type for returning Result<Serialized<T, S>, HttpException>.
LifecycleHook
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
List
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
NextFn
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};
NextFuture
This is the crate users will import. It re-exports the internal pieces use nestforge::{NestForgeFactory, ModuleDefinition, Container};

Attribute Macros§

authenticated
controller
The #[controller] macro is your starting point for defining a route group.
delete
description
dto
entity
entity_dto
get
id
identifiable
injectable
#[injectable] marks a struct as something NestForge can manage for you.
module
post
put
response
response_dto
roles
routes
#[routes] is where the magic happens for your controllers.
summary
tag
use_exception_filter
use_guard
use_interceptor
version

Derive Macros§

Identifiable
Validate