rust-cpython: rustdoc improvements By default, `cargo doc` builds the documentation for public constructs only, so we make public those that can. Since `cindex` is not safe, we keep it private. Unfortunately, the macro syntax of rust-cpython doesn't allow us to document the classes directly, so we resort to do that at the module level. Differential Revision: https://phab.mercurial-scm.org/D5546

     1

// ancestors.rs

     2

//

     3

// Copyright 2018 Georges Racinet <gracinet@anybox.fr>

     4

//

     5

// This software may be used and distributed according to the terms of the

     6

// GNU General Public License version 2 or any later version.

     7

     8

//! Bindings for Rust errors

     9

//!

    10

//! [`GraphError`] exposes `hg::GraphError` as a subclass of `ValueError`

    11

//!

    12

//! [`GraphError`]: struct.GraphError.html

    13

use cpython::exc::ValueError;

    14

use cpython::{PyErr, Python};

    15

use hg;

    16

    17

py_exception!(rustext, GraphError, ValueError);

    18

    19

impl GraphError {

    20

    pub fn pynew(py: Python, inner: hg::GraphError) -> PyErr {

    21

        match inner {

    22

            hg::GraphError::ParentOutOfRange(r) => {

    23

                GraphError::new(py, ("ParentOutOfRange", r))

    24

            }

    25

        }

    26

    }

    27

}