Skip to main content

Crate use_remix

Crate use_remix 

Source
Expand description

§use-remix

Remix framework primitive metadata for RustUse.

§Experimental

use-remix is experimental while use-js remains below 0.3.0.

§Example

use use_remix::{RemixRouteKind, RemixRoutePath, RemixVersionFamily};

let route = RemixRoutePath::new("/products/$productId")?;

assert_eq!(route.as_str(), "/products/$productId");
assert!(RemixRouteKind::IndexRoute.is_index_route());
assert_eq!(RemixVersionFamily::Remix2.as_str(), "remix2");

§Scope

  • Remix version-family, route-kind, file-kind, directory-kind, rendering-mode, config-file, and data-function labels.
  • Lightweight route path, route file name, and resource route name validation.

§Non-goals

  • Remix routing behavior.
  • Loader or action execution.
  • Server behavior, React behavior, compilation, project generation, or source parsing.
  • Shelling out to remix, vite, node, or package-manager tooling.

§License

Licensed under either Apache-2.0 or MIT.

Structs§

RemixResourceRouteName
Validated Remix resource route name metadata.
RemixRouteFileName
Validated Remix route file name metadata.
RemixRoutePath
Validated Remix route path metadata.

Enums§

RemixConfigFile
Common Remix config file labels.
RemixDataFunctionKind
Remix data function labels.
RemixDirectoryKind
Remix directory labels.
RemixFileKind
Remix file-kind labels.
RemixNameError
Error returned when Remix metadata is invalid.
RemixRenderingMode
Remix rendering-mode labels.
RemixRouteKind
Remix route-kind labels.
RemixVersionFamily
Remix version-family labels.