Где находится документация Rust для реализации признаков?

Question

Я хочу знать, что произойдет, если вы сделаете это:

use std::collections::HashMap; 

fn main() { 
    let mut hm: HashMap<i32, i32> = HashMap::new(); 
    hm.insert(1, 2); 
    let foo = hm[&100]; // Not in the map. 
} 

Я предполагаю, что я могу узнать, проверив ее, но если я хочу узнать из документации, где это говорит?

Если я перехожу на HashMap page, у него есть ссылка для impl Index, которая, как я полагаю, является соответствующим кодом, но это только что идет this generic Index documentation.

Это не ограничивается HashMap. Кажется, я не могу найти документацию для каких-либо реализаций признаков - только для самих признаков.

Answer 1

There is no further documentation for that implementation. Подпись все, что вы получите:

#[stable(feature = "rust1", since = "1.0.0")] 
impl<'a, K, Q: ?Sized, V, S> Index<&'a Q> for HashMap<K, V, S> 
    where K: Eq + Hash + Borrow<Q>, 
      Q: Eq + Hash, 
      S: HashState, 
{ 
    type Output = V; 

    #[inline] 
    fn index(&self, index: &Q) -> &V { 
     self.get(index).expect("no entry found for key") 
    } 
} 

Это характерно, хотя это не особенно хорошо.

Answer 2

С помощью этого кода:

/// A public trait with a method. 
pub trait Trait { 
    /// This method does something. 
    fn method(&self); 
} 

/// A public structure. 
pub struct X; 

/// An implementation of `Trait` for `X`. 
impl Trait for X { 
    /// This method does something specific for `X`. 
    fn method(&self) {} 
} 

rustdoc генерирует следующую документацию для X:

Вы можете увидеть, что документация реализации методы теряется, но документация реализации черты хранится неповрежденными.

Поэтому для авторов библиотек вопрос о том, пишут ли они документацию по внедрению признаков, это вопрос. Если они это сделают, вы можете найти их в разделе реализации признаков; если они этого не сделают, ну, в любом случае вы нигде не можете найти его. В этом конкретном случае реализация Index для HashMap не документирована.

(Это, вероятно, имеет смысл открыть вопрос Agains rustdoc добавить способность генерировать документацию для реализованных методов из признаков, если нет таких проблем пока нет.)