1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

#![cfg_attr(all(docs, not(doctest)), feature(doc_cfg))]
#![cfg_attr(all(docs, not(doctest)), feature(external_doc))]
#![cfg_attr(all(docs, not(doctest)), doc(include = "../README.md"))]
//!
// ^ is there so it looks like we have at some crate level docs when building
// without `--cfg docs` (i.e. on stable, when not building docs).

//! ## A Live Demo
//! <iframe
//!     title="Terminal"
//!     src="https://rrbutani.github.io/xterm-js-sys/examples/with-input/index.html"
//!     height="600"
//!     width="100%"
//!     frameborder="0"
//! ></iframe>

#![forbid(
    const_err,
    dead_code,
    improper_ctypes,
    non_shorthand_field_patterns,
    no_mangle_generic_items,
    overflowing_literals,
    path_statements,
    patterns_in_fns_without_body,
    private_in_public,
    unconditional_recursion,
    unused_allocation,
    unused_lifetimes,
    unused_comparisons,
    unused_parens,
    while_true
)]
#![deny(
    unused,
    bad_style,
    missing_debug_implementations,
    intra_doc_link_resolution_failure,
    missing_docs,
    unsafe_code,
    trivial_casts,
    trivial_numeric_casts,
    unused_extern_crates,
    unused_import_braces,
    unused_qualifications,
    unused_results,
    rust_2018_idioms,
    variant_size_differences
)]
#![deny(clippy::all, clippy::pedantic, clippy::cargo)]
#![deny(clippy::missing_docs_in_private_items)]
#![allow(clippy::type_repetition_in_bounds)]
#![doc(test(attr(
    deny(rust_2018_idioms, warnings),
    allow(unused_extern_crates)
)))]
#![doc(
    html_logo_url = "https://avatars2.githubusercontent.com/u/11927490?s=800&v=5",
    html_root_url = "https://docs.rs/xterm-js-sys/4.6.0", // remember to bump!
)]
// Note: Our MSRV doesn't have `broken_intra_doc_links` so we do this.
#![allow(unknown_lints)]
#![deny(broken_intra_doc_links)]
#![warn(unknown_lints)]

// TODO:
//  - add in an example/crate level docs here

/// Converts an `i32` into an `Option<u32>` (following the JS convention where
/// -1 indicates an error/lack of an element).
#[allow(clippy::cast_sign_loss)]
fn idx_to_opt(idx: i32) -> Option<u32> {
    match idx {
        -1 => None,
        0..=i32::MAX => Some(idx as u32),
        _ => unreachable!(),
    }
}

mod readonly_array;
pub use readonly_array::ReadOnlyArray;

pub mod xterm;
pub use xterm::Terminal;

#[cfg(feature = "crossterm-support")]
#[cfg_attr(all(docs, not(doctest)), doc(cfg(feature = "crossterm-support")))]
pub mod crossterm_support;

#[cfg(feature = "ext")]
#[cfg_attr(all(docs, not(doctest)), doc(cfg(feature = "ext")))]
pub mod ext;