mirror of
https://github.com/astral-sh/ruff.git
synced 2025-11-03 13:14:34 +00:00
34 lines
1.2 KiB
Rust
34 lines
1.2 KiB
Rust
//! Newtypes for working with text sizes/ranges in a more type-safe manner.
|
|
//!
|
|
//! This library can help with two things:
|
|
//! * Reducing storage requirements for offsets and ranges, under the
|
|
//! assumption that 32 bits is enough.
|
|
//! * Providing standard vocabulary types for applications where text ranges
|
|
//! are pervasive.
|
|
//!
|
|
//! However, you should not use this library simply because you work with
|
|
//! strings. In the overwhelming majority of cases, using `usize` and
|
|
//! `std::ops::Range<usize>` is better. In particular, if you are publishing a
|
|
//! library, using only std types in the interface would make it more
|
|
//! interoperable. Similarly, if you are writing something like a lexer, which
|
|
//! produces, but does not *store* text ranges, then sticking to `usize` would
|
|
//! be better.
|
|
//!
|
|
//! Minimal Supported Rust Version: latest stable.
|
|
|
|
#![forbid(unsafe_code)]
|
|
#![warn(missing_debug_implementations, missing_docs)]
|
|
|
|
mod range;
|
|
mod size;
|
|
mod traits;
|
|
|
|
#[cfg(feature = "schemars")]
|
|
mod schemars_impls;
|
|
#[cfg(feature = "serde")]
|
|
mod serde_impls;
|
|
|
|
pub use crate::{range::TextRange, size::TextSize, traits::TextLen};
|
|
|
|
#[cfg(target_pointer_width = "16")]
|
|
compile_error!("text-size assumes usize >= u32 and does not work on 16-bit targets");
|