Struct trillium_conn_id::ConnId [−][src]
pub struct ConnId { /* fields omitted */ }
Expand description
Trillium handler to set a identifier for every Conn.
By default, it will use an inbound x-request-id
request header or if
that is missing, populate a ten character random id. This handler will
set an outbound x-request-id
header as well by default. All of this
behavior can be customized with ConnId::with_request_header
,
ConnId::with_response_header
and ConnId::with_id_generator
Implementations
Constructs a new ConnId handler
fastrand::seed(1000); // for testing, so our id is predictable
let app = (ConnId::new(), "ok");
assert_ok!(
get("/").on(&app),
"ok",
"x-request-id" => "U14baHj9ho"
);
assert_headers!(
get("/")
.with_request_header("x-request-id", "inbound")
.on(&app),
"x-request-id" => "inbound"
);
Specifies a request header to use. If this header is provided on
the inbound request, the id will be used unmodified. To disable
this behavior, see ConnId::without_request_header
let app = (
ConnId::new().with_request_header("x-custom-id"),
"ok"
);
assert_headers!(
get("/")
.with_request_header("x-custom-id", "inbound")
.on(&app),
"x-request-id" => "inbound"
);
disables the default behavior of reusing an inbound header for
the request id. If a ConnId is configured
without_request_header
, a new id will always be generated
Specifies a response header to set. To disable this behavior, see
ConnId::without_response_header
fastrand::seed(1000); // for testing, so our id is predictable
let app = (
ConnId::new().with_response_header("x-custom-header"),
"ok"
);
assert_headers!(
get("/").on(&app),
"x-custom-header" => "U14baHj9ho"
);
Disables the default behavior of sending the conn id as a response
header. A request id will be available within the application
through use of ConnIdExt
but will not be sent as part of the
response.
Provide an alternative generator function for ids. The default is a ten-character alphanumeric random sequence.
let app = (
ConnId::new().with_id_generator(|| Uuid::new_v4().to_string()),
"ok"
);
// assert that the id is a valid uuid, even if we can't assert a specific value
assert!(Uuid::parse_str(get("/").on(&app).headers_mut().get_str("x-request-id").unwrap()).is_ok());
Trait Implementations
Executes this handler, performing any modifications to the Conn that are desired. Read more
Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this. Read more
Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code. Read more
predicate function answering the question of whether this Handler
would like to take ownership of the negotiated Upgrade. If this
returns true, you must implement Handler::upgrade
. The first
handler that responds true to this will receive ownership of the
trillium::Upgrade
in a subsequent call to Handler::upgrade
Read more
This will only be called if the handler reponds true to
Handler::has_upgrade
and will only be called once for this
upgrade. There is no return value, and this function takes
exclusive ownership of the underlying transport once this is
called. You can downcast the transport to whatever the source
transport type is and perform any non-http protocol communication
that has been negotiated. You probably don’t want this unless
you’re implementing something like websockets. Please note that
for many transports such as TcpStreams, dropping the transport
(and therefore the Upgrade) will hang up / disconnect. Read more