src/test/rustdoc/assoc-consts.rs

   1 // Copyright 2015 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 #![feature(associated_consts)]
  12
  13 pub trait Foo {
  14     // @has assoc_consts/trait.Foo.html '//*[@class="rust trait"]' \
  15     //      'const FOO: usize;'
  16     // @has - '//*[@id="associatedconstant.FOO"]' 'const FOO: usize'
  17     // @has - '//*[@class="docblock"]' 'FOO: usize = 12'
  18     const FOO: usize = 12;
  19     // @has - '//*[@id="associatedconstant.FOO_NO_DEFAULT"]' 'const FOO_NO_DEFAULT: bool'
  20     const FOO_NO_DEFAULT: bool;
  21     // @!has - FOO_HIDDEN
  22     #[doc(hidden)]
  23     const FOO_HIDDEN: u8 = 0;
  24 }
  25
  26 pub struct Bar;
  27
  28 impl Foo for Bar {
  29     // @has assoc_consts/struct.Bar.html '//code' 'impl Foo for Bar'
  30     // @has - '//*[@id="associatedconstant.FOO"]' 'const FOO: usize'
  31     // @has - '//*[@class="docblock"]' 'FOO: usize = 12'
  32     const FOO: usize = 12;
  33     // @has - '//*[@id="associatedconstant.FOO_NO_DEFAULT"]' 'const FOO_NO_DEFAULT: bool'
  34     // @has - '//*[@class="docblock"]' 'FOO_NO_DEFAULT: bool = false'
  35     const FOO_NO_DEFAULT: bool = false;
  36     // @!has - FOO_HIDDEN
  37     #[doc(hidden)]
  38     const FOO_HIDDEN: u8 = 0;
  39 }
  40
  41 impl Bar {
  42     // @has assoc_consts/struct.Bar.html '//*[@id="associatedconstant.BAR"]' \
  43     //      'const BAR: usize'
  44     // @has - '//*[@class="docblock"]' 'BAR: usize = 3'
  45     pub const BAR: usize = 3;
  46 }
  47
  48 pub struct Baz<'a, U: 'a, T>(T, &'a [U]);
  49
  50 impl Bar {
  51     // @has assoc_consts/struct.Bar.html '//*[@id="associatedconstant.BAZ"]' \
  52     //      "const BAZ: Baz<'static, u8, u32>"
  53     // @has - '//*[@class="docblock"]' "BAZ: Baz<'static, u8, u32> = Baz(321, &[1, 2, 3])"
  54     pub const BAZ: Baz<'static, u8, u32> = Baz(321, &[1, 2, 3]);
  55 }
  56
  57 pub fn f(_: &(ToString + 'static)) {}
  58
  59 impl Bar {
  60     // @has assoc_consts/struct.Bar.html '//*[@id="associatedconstant.F"]' \
  61     //      "const F: fn(_: &(ToString + 'static))"
  62     // @has - '//*[@class="docblock"]' "F: fn(_: &(ToString + 'static)) = f"
  63     pub const F: fn(_: &(ToString + 'static)) = f;
  64 }
  65
  66 impl Bar {
  67     // @!has assoc_consts/struct.Bar.html 'BAR_PRIVATE'
  68     const BAR_PRIVATE: char = 'a';
  69     // @!has assoc_consts/struct.Bar.html 'BAR_HIDDEN'
  70     #[doc(hidden)]
  71     pub const BAR_HIDDEN: &'static str = "a";
  72 }
  73
  74 // @has assoc_consts/trait.Qux.html
  75 pub trait Qux {
  76     // @has - '//*[@id="associatedconstant.QUX0"]' 'const QUX0: u8'
  77     // @has - '//*[@class="docblock"]' "Docs for QUX0 in trait."
  78     /// Docs for QUX0 in trait.
  79     const QUX0: u8;
  80     // @has - '//*[@id="associatedconstant.QUX1"]' 'const QUX1: i8'
  81     // @has - '//*[@class="docblock"]' "Docs for QUX1 in trait."
  82     /// Docs for QUX1 in trait.
  83     const QUX1: i8;
  84     // @has - '//*[@id="associatedconstant.QUX_DEFAULT0"]' 'const QUX_DEFAULT0: u16'
  85     // @has - '//*[@class="docblock"]' "QUX_DEFAULT0: u16 = 1"
  86     // @has - '//*[@class="docblock"]' "Docs for QUX_DEFAULT0 in trait."
  87     /// Docs for QUX_DEFAULT0 in trait.
  88     const QUX_DEFAULT0: u16 = 1;
  89     // @has - '//*[@id="associatedconstant.QUX_DEFAULT1"]' 'const QUX_DEFAULT1: i16'
  90     // @has - '//*[@class="docblock"]' "QUX_DEFAULT1: i16 = 2"
  91     // @has - '//*[@class="docblock"]' "Docs for QUX_DEFAULT1 in trait."
  92     /// Docs for QUX_DEFAULT1 in trait.
  93     const QUX_DEFAULT1: i16 = 2;
  94     // @has - '//*[@id="associatedconstant.QUX_DEFAULT2"]' 'const QUX_DEFAULT2: u32'
  95     // @has - '//*[@class="docblock"]' "QUX_DEFAULT2: u32 = 3"
  96     // @has - '//*[@class="docblock"]' "Docs for QUX_DEFAULT2 in trait."
  97     /// Docs for QUX_DEFAULT2 in trait.
  98     const QUX_DEFAULT2: u32 = 3;
  99 }
 100
 101 // @has assoc_consts/struct.Bar.html '//code' 'impl Qux for Bar'
 102 impl Qux for Bar {
 103     // @has - '//*[@id="associatedconstant.QUX0"]' 'const QUX0: u8'
 104     // @has - '//*[@class="docblock"]' "QUX0: u8 = 4"
 105     // @has - '//*[@class="docblock"]' "Docs for QUX0 in trait."
 106     /// Docs for QUX0 in trait.
 107     const QUX0: u8 = 4;
 108     // @has - '//*[@id="associatedconstant.QUX1"]' 'const QUX1: i8'
 109     // @has - '//*[@class="docblock"]' "QUX1: i8 = 5"
 110     // @has - '//*[@class="docblock"]' "Docs for QUX1 in impl."
 111     /// Docs for QUX1 in impl.
 112     const QUX1: i8 = 5;
 113     // @has - '//*[@id="associatedconstant.QUX_DEFAULT0"]' 'const QUX_DEFAULT0: u16'
 114     // @has - '//*[@class="docblock"]' "QUX_DEFAULT0: u16 = 6"
 115     // @has - '//*[@class="docblock"]' "Docs for QUX_DEFAULT0 in trait."
 116     const QUX_DEFAULT0: u16 = 6;
 117     // @has - '//*[@id="associatedconstant.QUX_DEFAULT1"]' 'const QUX_DEFAULT1: i16'
 118     // @has - '//*[@class="docblock"]' "QUX_DEFAULT1: i16 = 7"
 119     // @has - '//*[@class="docblock"]' "Docs for QUX_DEFAULT1 in impl."
 120     /// Docs for QUX_DEFAULT1 in impl.
 121     const QUX_DEFAULT1: i16 = 7;
 122     // @has - '//*[@id="associatedconstant.QUX_DEFAULT2"]' 'const QUX_DEFAULT2: u32'
 123     // @has - '//*[@class="docblock"]' "QUX_DEFAULT2: u32 = 3"
 124     // @has - '//*[@class="docblock"]' "Docs for QUX_DEFAULT2 in trait."
 125 }