4af3494bb0
This commit applies the stabilization of std::fmt as outlined in [RFC 380][rfc]. There are a number of breaking changes as a part of this commit which will need to be handled to migrated old code: * A number of formatting traits have been removed: String, Bool, Char, Unsigned, Signed, and Float. It is recommended to instead use Show wherever possible or to use adaptor structs to implement other methods of formatting. * The format specifier for Boolean has changed from `t` to `b`. * The enum `FormatError` has been renamed to `Error` as well as becoming a unit struct instead of an enum. The `WriteError` variant no longer exists. * The `format_args_method!` macro has been removed with no replacement. Alter code to use the `format_args!` macro instead. * The public fields of a `Formatter` have become read-only with no replacement. Use a new formatting string to alter the formatting flags in combination with the `write!` macro. The fields can be accessed through accessor methods on the `Formatter` structure. Other than these breaking changes, the contents of std::fmt should now also all contain stability markers. Most of them are still #[unstable] or #[experimental] [rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0380-stabilize-std-fmt.md [breaking-change] Closes #18904
80 lines
2.5 KiB
Rust
80 lines
2.5 KiB
Rust
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
|
|
// file at the top-level directory of this distribution and at
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
// option. This file may not be copied, modified, or distributed
|
|
// except according to those terms.
|
|
|
|
//! This is an internal module used by the ifmt! runtime. These structures are
|
|
//! emitted to static arrays to precompile format strings ahead of time.
|
|
//!
|
|
//! These definitions are similar to their `ct` equivalents, but differ in that
|
|
//! these can be statically allocated and are slightly optimized for the runtime
|
|
|
|
#![experimental = "implementation detail of the `format_args!` macro"]
|
|
|
|
pub use self::Alignment::*;
|
|
pub use self::Count::*;
|
|
pub use self::Position::*;
|
|
pub use self::Flag::*;
|
|
|
|
#[doc(hidden)]
|
|
pub struct Argument<'a> {
|
|
pub position: Position,
|
|
pub format: FormatSpec,
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
pub struct FormatSpec {
|
|
pub fill: char,
|
|
pub align: Alignment,
|
|
pub flags: uint,
|
|
pub precision: Count,
|
|
pub width: Count,
|
|
}
|
|
|
|
/// Possible alignments that can be requested as part of a formatting directive.
|
|
#[deriving(PartialEq)]
|
|
pub enum Alignment {
|
|
/// Indication that contents should be left-aligned.
|
|
AlignLeft,
|
|
/// Indication that contents should be right-aligned.
|
|
AlignRight,
|
|
/// Indication that contents should be center-aligned.
|
|
AlignCenter,
|
|
/// No alignment was requested.
|
|
AlignUnknown,
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
pub enum Count {
|
|
CountIs(uint), CountIsParam(uint), CountIsNextParam, CountImplied,
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
pub enum Position {
|
|
ArgumentNext, ArgumentIs(uint)
|
|
}
|
|
|
|
/// Flags which can be passed to formatting via a directive.
|
|
///
|
|
/// These flags are discovered through the `flags` field of the `Formatter`
|
|
/// structure. The flag in that structure is a union of these flags into a
|
|
/// `uint` where each flag's discriminant is the corresponding bit.
|
|
pub enum Flag {
|
|
/// A flag which enables number formatting to always print the sign of a
|
|
/// number.
|
|
FlagSignPlus,
|
|
/// Currently not a used flag
|
|
FlagSignMinus,
|
|
/// Indicates that the "alternate formatting" for a type should be used.
|
|
///
|
|
/// The meaning of this flag is type-specific.
|
|
FlagAlternate,
|
|
/// Indicates that padding should be done with a `0` character as well as
|
|
/// being aware of the sign to be printed.
|
|
FlagSignAwareZeroPad,
|
|
}
|