src/libcore/fmt/rt.rs

   1 // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! This is an internal module used by the ifmt! runtime. These structures are
  12 //! emitted to static arrays to precompile format strings ahead of time.
  13 //!
  14 //! These definitions are similar to their `ct` equivalents, but differ in that
  15 //! these can be statically allocated and are slightly optimized for the runtime
  16
  17 #![experimental = "implementation detail of the `format_args!` macro"]
  18
  19 pub use self::Alignment::*;
  20 pub use self::Count::*;
  21 pub use self::Position::*;
  22 pub use self::Flag::*;
  23
  24 #[doc(hidden)]
  25 pub struct Argument<'a> {
  26     pub position: Position,
  27     pub format: FormatSpec,
  28 }
  29
  30 #[doc(hidden)]
  31 pub struct FormatSpec {
  32     pub fill: char,
  33     pub align: Alignment,
  34     pub flags: uint,
  35     pub precision: Count,
  36     pub width: Count,
  37 }
  38
  39 /// Possible alignments that can be requested as part of a formatting directive.
  40 #[deriving(PartialEq)]
  41 pub enum Alignment {
  42     /// Indication that contents should be left-aligned.
  43     AlignLeft,
  44     /// Indication that contents should be right-aligned.
  45     AlignRight,
  46     /// Indication that contents should be center-aligned.
  47     AlignCenter,
  48     /// No alignment was requested.
  49     AlignUnknown,
  50 }
  51
  52 #[doc(hidden)]
  53 pub enum Count {
  54     CountIs(uint), CountIsParam(uint), CountIsNextParam, CountImplied,
  55 }
  56
  57 #[doc(hidden)]
  58 pub enum Position {
  59     ArgumentNext, ArgumentIs(uint)
  60 }
  61
  62 /// Flags which can be passed to formatting via a directive.
  63 ///
  64 /// These flags are discovered through the `flags` field of the `Formatter`
  65 /// structure. The flag in that structure is a union of these flags into a
  66 /// `uint` where each flag's discriminant is the corresponding bit.
  67 pub enum Flag {
  68     /// A flag which enables number formatting to always print the sign of a
  69     /// number.
  70     FlagSignPlus,
  71     /// Currently not a used flag
  72     FlagSignMinus,
  73     /// Indicates that the "alternate formatting" for a type should be used.
  74     ///
  75     /// The meaning of this flag is type-specific.
  76     FlagAlternate,
  77     /// Indicates that padding should be done with a `0` character as well as
  78     /// being aware of the sign to be printed.
  79     FlagSignAwareZeroPad,
  80 }