Limiting Factor - Revision history

Dereckson: /* Order of extractors */

2025-09-24T17:26:52Z

Order of extractors

← Older revision		Revision as of 17:26, 24 September 2025
Line 10:		Line 10:
	For example, to use RequestBody:		For example, to use RequestBody:

	<syntaxhighlight ~~language~~="rust">		<syntaxhighlight lang="rust">
	use limiting_factor_axum::api::guards::AxumRequestBody as RequestBody;		use limiting_factor_axum::api::guards::AxumRequestBody as RequestBody;

Dereckson at 17:26, 24 September 2025

2025-09-24T17:26:24Z

← Older revision		Revision as of 17:26, 24 September 2025
Line 41:		Line 41:

	See https://docs.rs/axum/0.8.4/axum/struct.Router.html		See https://docs.rs/axum/0.8.4/axum/struct.Router.html

			== See also ==

			;Limiting Factor
			* [https://devcentral.nasqueron.org/project/view/119/ Project board / bug tracker]
			* [https://devcentral.nasqueron.org/source/limiting-factor/ Source code]

			;Nasqueron components using Limiting Factor
			* [https://devcentral.nasqueron.org/source/alkane/ Alkane]
			* [https://devcentral.nasqueron.org/source/docker-registry-api/ Nasqueron private Docker registry API]

Dereckson at 17:18, 24 September 2025

2025-09-24T17:18:45Z

← Older revision		Revision as of 17:18, 24 September 2025
Line 1:		Line 1:
	Limiting Factor is a library to help develop API in Rust, with Axum or Rocket 0.4 frameworks.		'''Limiting Factor''' is a library to help develop API in Rust, with Axum or Rocket 0.4 frameworks.

	== Development with Limiting Factor ==		== Development with Limiting Factor ==

Dereckson at 17:18, 24 September 2025

2025-09-24T17:18:36Z

← Older revision		Revision as of 17:18, 24 September 2025
Line 1:		Line 1:
			Limiting Factor is a library to help develop API in Rust, with Axum or Rocket 0.4 frameworks.

	== Development with Limiting Factor ==		== Development with Limiting Factor ==
	=== Axum ===		=== Axum ===

Dereckson: Created page with "== Development with Limiting Factor == === Axum === Gotchas during development of With axum and limiting-factor-axum: ==== Order of extractors ==== [https://docs.rs/axum/latest/axum/extract/index.html#the-order-of-extractors axum::extract order of extractors] - the request is consumed by an extractor, so it must be the LAST parameter of any request handler method. For example, to use RequestBody: use limiting_factor_axum::api::guards:..."

2025-09-24T17:15:50Z

Created page with "== Development with Limiting Factor == === Axum === Gotchas during development of With axum and limiting-factor-axum: ==== Order of extractors ==== [https://docs.rs/axum/latest/axum/extract/index.html#the-order-of-extractors axum::extract order of extractors] - the request is consumed by an extractor, so it must be the LAST parameter of any request handler method. For example, to use RequestBody: <syntaxhighlight language="rust"> use limiting_factor_axum::api::guards:..."

New page

== Development with Limiting Factor ==
=== Axum ===
Gotchas during development of With axum and limiting-factor-axum:

==== Order of extractors ====
[https://docs.rs/axum/latest/axum/extract/index.html#the-order-of-extractors axum::extract order of extractors] - the request is consumed by an extractor, so it must be the LAST parameter of any request handler method.

For example, to use RequestBody:

<syntaxhighlight language="rust">
use limiting_factor_axum::api::guards::AxumRequestBody as RequestBody;

// Valid code
pub async fn init(
Path(site_name): Path<String>,
State(config): State<AlkaneConfig>,
context: RequestBody,
) -> Json<T> {
...
}

// Will trigger a compile error with axum even if that order is fine on Rocket
pub async fn init(
Path(site_name): Path<String>,
context: RequestBody,
State(config): State<AlkaneConfig>,
) -> Json<T> {
...
}
</syntaxhighlight>

== Development of Limiting Factor crates ==
=== Axum ===
==== Router ====

The Router type is documented to be <code><nowiki>Router<S></nowiki></code> where S is the type of the state. This S has a very axum-specific special meaning, it means "the router needs a state of type S, and that state is still missing".

When we missed that information, it was tempting to use <code><nowiki>Router<S></nowiki></code> for App structure. As the final router passed to axum::serve was <code><nowiki>Router<S></nowiki></code> instead of <code>Router<()></code>, compiler complained about cumbersome and complex missing traits for S.

See https://docs.rs/axum/0.8.4/axum/struct.Router.html