linux-toradex.git/rust/kernel/str.rs, branch v6.3-rc5

rust: str: add `fmt!` macro

2022-12-04T00:59:16+00:00

Add the `fmt!` macro, which is a convenience alias for the Rust
`core::format_args!` macro.

For instance, it may be used to create a `CString`:

    CString::try_from_fmt(fmt!("{}{}", "abc", 42))?

Signed-off-by: Wedson Almeida Filho 
Reviewed-by: Gary Guo 
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda

rust: str: add `CString` type

2022-12-04T00:59:15+00:00

Add the `CString` type, which is an owned string that is guaranteed
to have exactly one `NUL` byte at the end, i.e. the owned equivalent
to `CStr` introduced earlier.

It is used for interoperability with kernel APIs that take C strings.

In order to do so, implement the `RawFormatter::new()` constructor
and the `RawFormatter::bytes_written()` method as well.

Signed-off-by: Wedson Almeida Filho 
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda

rust: str: add `Formatter` type

2022-12-04T00:59:15+00:00

Add the `Formatter` type, which leverages `RawFormatter`,
but fails if callers attempt to write more than will fit
in the buffer.

In order to so, implement the `RawFormatter::from_buffer()`
constructor as well.

Co-developed-by: Adam Bratschi-Kaye 
Signed-off-by: Adam Bratschi-Kaye 
Signed-off-by: Wedson Almeida Filho 
Reviewed-by: Gary Guo 
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda

rust: str: add `c_str!` macro

2022-12-04T00:59:15+00:00

Add `c_str!`, which is a convenience macro that creates a new `CStr`
from a string literal.

It is designed to be similar to a `str` in usage, and it is usable
in const contexts, for instance:

    const X: &CStr = c_str!("Example");

Co-developed-by: Alex Gaynor 
Signed-off-by: Alex Gaynor 
Signed-off-by: Gary Guo 
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda

rust: str: add `CStr` unit tests

2022-12-04T00:59:15+00:00

Add unit tests for `CStr::from_bytes_with_nul()` and
`CStr::from_bytes_with_nul_unchecked()`.

These serve as an example of the first unit tests for Rust code
(i.e. different from documentation tests).

Signed-off-by: Milan Landaverde 
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda

rust: str: implement several traits for `CStr`

2022-12-04T00:59:15+00:00

Implement `Debug`, `Display`, `Deref` (into `BStr`), `AsRef`
and a set of `Index<...>` traits.

This makes it `CStr` more convenient to use (and closer to `str`).

Co-developed-by: Alex Gaynor 
Signed-off-by: Alex Gaynor 
Co-developed-by: Morgan Bartlett 
Signed-off-by: Morgan Bartlett 
Signed-off-by: Gary Guo 
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda

rust: str: add `CStr` type

2022-12-04T00:59:15+00:00

Add the `CStr` type, which is a borrowed string that is guaranteed
to have exactly one `NUL` byte, which is at the end.

It is used for interoperability with kernel APIs that take C strings.

Add it to the prelude too.

Co-developed-by: Alex Gaynor 
Signed-off-by: Alex Gaynor 
Co-developed-by: Milan Landaverde 
Signed-off-by: Milan Landaverde 
Signed-off-by: Gary Guo 
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda

rust: str: add `b_str!` macro

2022-12-04T00:59:15+00:00

Add the `b_str!` macro, which creates a new `BStr` from
a string literal.

It is usable in const contexts, for instance:

    const X: &BStr = b_str!("Example");

Signed-off-by: Gary Guo 
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda

rust: str: add `BStr` type

2022-12-04T00:59:15+00:00

Add the `BStr` type, which is a byte string without UTF-8
validity guarantee.

It is simply an alias to `[u8]`, but has a more evident
semantical meaning.

Signed-off-by: Gary Guo 
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda

rust: add `kernel` crate

2022-09-28T06:58:24+00:00

The `kernel` crate currently includes all the abstractions that wrap
kernel features written in C.

These abstractions call the C side of the kernel via the generated
bindings with the `bindgen` tool. Modules developed in Rust should
never call the bindings themselves.

In the future, as the abstractions grow in number, we may need
to split this crate into several, possibly following a similar
subdivision in subsystems as the kernel itself and/or moving
the code to the actual subsystems.

Reviewed-by: Greg Kroah-Hartman 
Co-developed-by: Alex Gaynor 
Signed-off-by: Alex Gaynor 
Co-developed-by: Geoffrey Thomas 
Signed-off-by: Geoffrey Thomas 
Co-developed-by: Finn Behrens 
Signed-off-by: Finn Behrens 
Co-developed-by: Adam Bratschi-Kaye 
Signed-off-by: Adam Bratschi-Kaye 
Co-developed-by: Sven Van Asbroeck 
Signed-off-by: Sven Van Asbroeck 
Co-developed-by: Gary Guo 
Signed-off-by: Gary Guo 
Co-developed-by: Boris-Chengbiao Zhou 
Signed-off-by: Boris-Chengbiao Zhou 
Co-developed-by: Boqun Feng 
Signed-off-by: Boqun Feng 
Co-developed-by: Fox Chen 
Signed-off-by: Fox Chen 
Co-developed-by: Viktor Garske 
Signed-off-by: Viktor Garske 
Co-developed-by: Dariusz Sosnowski 
Signed-off-by: Dariusz Sosnowski 
Co-developed-by: Léo Lanteri Thauvin 
Signed-off-by: Léo Lanteri Thauvin 
Co-developed-by: Niklas Mohrin 
Signed-off-by: Niklas Mohrin 
Co-developed-by: Milan Landaverde 
Signed-off-by: Milan Landaverde 
Co-developed-by: Morgan Bartlett 
Signed-off-by: Morgan Bartlett 
Co-developed-by: Maciej Falkowski 
Signed-off-by: Maciej Falkowski 
Co-developed-by: Nándor István Krácser 
Signed-off-by: Nándor István Krácser 
Co-developed-by: David Gow 
Signed-off-by: David Gow 
Co-developed-by: John Baublitz 
Signed-off-by: John Baublitz 
Co-developed-by: Björn Roy Baron 
Signed-off-by: Björn Roy Baron 
Signed-off-by: Wedson Almeida Filho 
Co-developed-by: Miguel Ojeda 
Signed-off-by: Miguel Ojeda