Skip to main content

Crate use_crate

Crate use_crate 

Source
Expand description

§use-crate

Composable crate identity and metadata primitives for RustUse.

use-crate provides typed helpers for crate names, naming rules, expected RustUse URLs, and lightweight crate metadata validation.

§Example

use use_crate::{crate_name_to_module_name, expected_repository_url};

assert_eq!(crate_name_to_module_name("use-release"), "use_release");
assert_eq!(
    expected_repository_url("use-release").as_str(),
    "https://github.com/RustUse/use-release"
);

Crate identity, naming, and publishability primitives.

Structs§

CrateMetadata
Lightweight crate metadata for RustUse validation.
CrateName
A validated crate name.
CrateNameError
An error returned when a crate name fails validation.
DocumentationUrl
A documentation URL.
RepositoryUrl
A repository URL.

Enums§

CrateKind
A broad crate kind classification.
PublishStatus
The publish status inferred from manifest metadata.

Functions§

crate_name_to_module_name
Converts a crate name like use-release into a Rust module name.
expected_docs_url
Returns the expected docs.rs URL for a crate name.
expected_repository_url
Returns the expected RustUse GitHub repository URL for a repository name.
is_publishable
Returns true when crate metadata is publishable and follows RustUse defaults.
is_use_prefixed
Returns true when a crate name uses the RustUse use-* prefix.
is_valid_crate_name
Returns true when a value is a valid crate name under RustUse defaults.
module_name_to_crate_name
Converts a Rust module name like use_release into a crate name.
normalize_crate_name
Normalizes a crate name by trimming, ASCII-lowercasing, replacing spaces or underscores with hyphens, collapsing repeated hyphens, and trimming edges.
validate_crate_metadata
Validates crate metadata against RustUse naming and URL defaults.