Mbus API

https://docs.rs/mbus-api/latest/mbus_api
Admin
A Rust library that provides client and server components, data models, and API traits for...
Tokens:276,720
Snippets:3,069
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example of trim_start_matches

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Address.html?search=

Demonstrates removing characters from the start of a string slice.

```Rust
let x: &[_] = &['1', '2'];
assert_eq!("12foo1bar12".trim_start_matches(x), "foo1bar12");
```

--------------------------------

### Trim Start Matches Examples

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=std%3A%3Avec

Removes all prefixes that match a specified pattern, which can be a character, string slice, or a closure.

```rust
assert_eq!("11foo1bar11".trim_start_matches('1'), "foo1bar11");
assert_eq!("123foo1bar123".trim_start_matches(char::is_numeric), "foo1bar123");
```

--------------------------------

### Trim Start Example

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=std%3A%3Avec

Demonstrates removing leading whitespace from a string slice. 'Whitespace' is defined by Unicode's White_Space property.

```rust
let s = "  עברית  ";
assert!(Some('ע') == s.trim_start().chars().next());
```

--------------------------------

### get

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.Api.html?search=u32+-%3E+bool

Retrieves data from a specific device with given parameters.

```APIDOC
## get

### Description
Retrieves data from a specific device.

### Parameters
- **device** (String) - Description of the device identifier.
- **baudrate** (Baudrate) - The baud rate for communication.
- **address** (String) - The address of the device.
- **context** (C) - The context for the operation.

### Returns
- Result<GetResponse, ApiError> - A future that resolves to a GetResponse or an ApiError.
```

--------------------------------

### get

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.ApiNoContext.html

Retrieves data for a specific MBus device, baudrate, and address.

```APIDOC
## get

### Description
Retrieves data for a specific MBus device, baudrate, and address.

### Method
Not specified (likely asynchronous call within the trait)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **GetResponse** (type) - The response containing the retrieved data.

#### Response Example
None
```

--------------------------------

### rsplit_terminator Example

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=std%3A%3Avec

Demonstrates the usage of rsplit_terminator with multiple delimiters.

```rust
let v: Vec<&str> = "A.B:C.D".rsplit_terminator(&['.', ':'][..]).collect();
assert_eq!(v, ["D", "C", "B", "A"]);
```

--------------------------------

### get

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html

Retrieves data for a specific device with specified baud rate and address.

```APIDOC
## get

### Description
Retrieves data for a specific device with specified baud rate and address.

### Method
GET

### Endpoint
/api/v1/device/{param_device}/baudrate/{param_baudrate}/address/{param_address}

### Parameters
#### Path Parameters
- **param_device** (string) - Required - The device identifier.
- **param_baudrate** (Baudrate) - Required - The baud rate for communication.
- **param_address** (string) - Required - The address of the device.

#### Query Parameters
None

### Request Example
None provided in source.

### Response
#### Success Response (200)
- **GetResponse** - The response object containing the retrieved data.

#### Response Example
None provided in source.
```

--------------------------------

### Trim End Example (English)

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Yaml.html?search=std%3A%3Avec

Demonstrates removing trailing whitespace from a string containing English characters.

```rust
let s = "  English  ";
assert!(Some('h') == s.trim_end().chars().rev().next());
```

--------------------------------

### Get Data from Device

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.Api.html

Retrieves a single data frame from a specified device. Requires device, baudrate, and address.

```rust
fn get<'life0, 'life1, 'async_trait>(
        &'life0 self,
        device: String,
        baudrate: Baudrate,
        address: String,
        context: &'life1 C,
    ) -> Pin<Box<dyn Future<Output = Result<GetResponse, ApiError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
```

--------------------------------

### Trim Left Example (English)

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Yaml.html?search=std%3A%3Avec

Demonstrates removing leading whitespace from a string containing English characters. This method is deprecated.

```rust
let s = "  English";
assert!(Some('E') == s.trim_left().chars().next());
```

--------------------------------

### Client::try_new

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html

Creates a basic HTTP client.

```APIDOC
## Client::try_new

### Description
Create an HTTP client.

### Method
`pub fn try_new<C>(base_path: &str) -> Result<Self, ClientInitError>`

### Parameters
#### Arguments
* `base_path` - base path of the client API, i.e. “http://www.my-api-implementation.com”
```

--------------------------------

### Create Client with Custom Service

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html

Constructs a Client by providing a pre-configured `hyper::service::Service` or `tower::Service`. This allows for custom transport layer wrappers, such as logging.

```rust
pub fn try_new_with_client_service<S, C>(
    client_service: S,
    base_path: &str,
) -> Result<Self, ClientInitError>
where S: Service<(Request<Body>, C), Response = Response<Body>> + Clone + Sync + Send + 'static,
    S::Future: Send + 'static,
    S::Error: Into<Box<dyn Error + Send + Sync + 'static>> + Display,
    C: Clone + Send + Sync + 'static,
```

--------------------------------

### Turn On HAT

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.Api.html

Enables the HAT on the device. Requires only a context.

```rust
fn hat_on<'life0, 'life1, 'async_trait>(
        &'life0 self,
        context: &'life1 C,
    ) -> Pin<Box<dyn Future<Output = Result<HatOnResponse, ApiError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
```

--------------------------------

### Safe String Slicing with `get`

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=std%3A%3Avec

Use `get` for non-panicking string slicing. It returns `None` if the indices are out of bounds or do not align with UTF-8 character boundaries.

```rust
let v = String::from("🗻∈🌏");

assert_eq!(Some("🗻"), v.get(0..4));

// indices not on UTF-8 sequence boundaries
assert!(v.get(1..).is_none());
assert!(v.get(..8).is_none());

// out of bounds
assert!(v.get(..42).is_none());
```

--------------------------------

### Create Client with Service

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

A general constructor that allows creating a `Client` by providing a pre-configured `hyper::service::Service` or `tower::Service`. This enables advanced customization by wrapping the underlying transport layer, for instance, for request logging.

```rust
pub fn try_new_with_client_service(
    client_service: S,
    base_path: &str,
) -> Result<Self, ClientInitError>
```

--------------------------------

### impl<T> Any for T

Source: https://docs.rs/mbus-api/latest/mbus_api/context/struct.AddContext.html?search=std%3A%3Avec

Provides the `type_id` method to get the `TypeId` of an object.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Method
N/A (Method on a trait implementation)

### Parameters
None

### Returns
- `TypeId`: The unique identifier for the type of `self`.
```

--------------------------------

### Create HTTP Client (Alternative)

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html

An alternative method to create an HTTP client. This is functionally similar to `try_new`.

```rust
pub fn try_new_http(base_path: &str) -> Result<Self, ClientInitError>
```

--------------------------------

### hat_on

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html?search=u32+-%3E+bool

Turns on the HAT device.

```APIDOC
## hat_on

### Description
Turns on the HAT device.

### Method
POST

### Endpoint
/hat/on

### Response
#### Success Response (200)
- **HatOnResponse** - The response confirming the HAT is turned on.
```

--------------------------------

### hat_on

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html?search=std%3A%3Avec

Turns on the HAT device.

```APIDOC
## hat_on

### Description
Turns on the HAT device.

### Method
POST

### Endpoint
/api/client/hat_on

### Response
#### Success Response (200)
- **HatOnResponse** - The response indicating the HAT device is on.
```

--------------------------------

### Get MBus API Status

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.Api.html?search=

Retrieves the status of the MBus API.

```APIDOC
## GET /api/mbus_api

### Description
Retrieves the status of the MBus API.

### Method
GET

### Endpoint
`/api/mbus_api`

### Response
#### Success Response (200)
- **MbusApiResponse** - The response containing the MBus API status.
```

--------------------------------

### Get Mbus API Info

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves information about the M-Bus API.

```APIDOC
## GET /mbus_api

### Description
Retrieves information about the M-Bus API.

### Method
GET

### Endpoint
`/mbus_api`

### Response
#### Success Response (200)
- **MbusApiResponse** - The response containing M-Bus API information.

#### Response Example
```json
{
  "example": "MbusApiResponse"
}
```
```

--------------------------------

### Get Mbus API Information

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html?search=

Retrieves information about the Mbus API.

```APIDOC
## mbus_api

### Description
Retrieves information about the Mbus API.

### Method
GET (assumed, based on function name and return type)

### Endpoint
Not explicitly defined, but implies a GET request to an API information resource.

### Parameters
#### Path Parameters
None explicitly defined.

#### Query Parameters
None explicitly defined.

#### Request Body
None explicitly defined.

### Parameters
- **context** (C) - Required - The context for the request.

### Response
#### Success Response (200)
- **MbusApiResponse** - The response containing Mbus API information.
```

--------------------------------

### Client::try_new_with_client_service

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html?search=std%3A%3Avec

Constructs a Client by providing a pre-made hyper::service::Service or tower::Service, allowing for custom transport layer wrappers.

```APIDOC
## Client::try_new_with_client_service

### Description
Constructor for creating a `Client` by passing in a pre-made `hyper::service::Service` / `tower::Service`
This allows adding custom wrappers around the underlying transport, for example for logging.

### Method
`pub fn try_new_with_client_service`

### Parameters
#### Arguments
- `client_service` (S) - The pre-made service to use for the client.
- `base_path` (str) - The base path of the client API.

### Returns
`Result<Self, ClientInitError>`
```

--------------------------------

### Create HTTP Client

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html

Creates a standard HTTP client. Use this for connections to servers that do not use TLS.

```rust
pub fn try_new(base_path: &str) -> Result<Self, ClientInitError>
```

--------------------------------

### Client::try_new_with_client_service

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html

Constructs a Client by providing a pre-made hyper::service::Service or tower::Service. This allows for custom transport layer wrappers, such as logging.

```APIDOC
## Client::try_new_with_client_service

### Description
Constructor for creating a `Client` by passing in a pre-made `hyper::service::Service` / `tower::Service`. This allows adding custom wrappers around the underlying transport, for example for logging.

### Method
`pub fn try_new_with_client_service<S, C>(client_service: S, base_path: &str) -> Result<Self, ClientInitError>`

### Parameters
#### Arguments
* `client_service` - The pre-made service to use for the client.
* `base_path` - base path of the client API, i.e. “http://www.my-api-implementation.com”
```

--------------------------------

### Example of trim_end_matches with a character

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=u32+-%3E+bool

Repeatedly removes a specific character from the end of a string.

```rust
assert_eq!("11foo1bar11".trim_end_matches('1'), "11foo1bar");
```

--------------------------------

### Create Client with Custom Connector

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html

Creates a client using a custom hyper::client::Connect implementation. Useful for advanced scenarios like protocol logging.

```rust
pub fn try_new_with_connector(
    base_path: &str,
    protocol: Option<&'static str>,
    connector: Connector,
) -> Result<Self, ClientInitError>
```

--------------------------------

### Get HAT Status

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.Api.html?search=

Retrieves the current status of the HAT (Hardware Attached on Top).

```APIDOC
## GET /api/hat

### Description
Retrieves the current status of the HAT.

### Method
GET

### Endpoint
`/api/hat`

### Response
#### Success Response (200)
- **HatResponse** - The response containing the HAT status.
```

--------------------------------

### Service Constructor

Source: https://docs.rs/mbus-api/latest/mbus_api/server/struct.Service.html?search=std%3A%3Avec

Creates a new instance of the Service with the provided API implementation.

```APIDOC
## fn new(api_impl: T) -> Self

### Description
Creates a new instance of the Service.

### Parameters
- **api_impl** (T) - The API implementation to be used by the service.
```

--------------------------------

### Get Multiple Frames from Device

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html?search=

Retrieves multiple frames of data from a specific device.

```APIDOC
## get_multi

### Description
Retrieves multiple frames of data from a specific device.

### Method
GET (assumed, based on function name and return type)

### Endpoint
Not explicitly defined, but implies a GET request to a resource for multiple frames.

### Parameters
#### Path Parameters
None explicitly defined.

#### Query Parameters
None explicitly defined.

#### Request Body
None explicitly defined.

### Parameters
- **param_device** (String) - Required - The identifier of the device.
- **param_baudrate** (Baudrate) - Required - The baud rate for communication.
- **param_address** (String) - Required - The address of the device.
- **param_maxframes** (i32) - Required - The maximum number of frames to retrieve.
- **context** (C) - Required - The context for the request.

### Response
#### Success Response (200)
- **GetMultiResponse** - The response containing the multiple frames of data.
```

--------------------------------

### with_context Method

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.ContextWrapperExt.html?search=u32+-%3E+bool

Binds the current API to a specified context, returning a ContextWrapper.

```APIDOC
## fn with_context(self, context: C) -> ContextWrapper<Self, C>

### Description
Binds this API to a context.

### Parameters
- **context** (C) - Description of the context parameter.
```

--------------------------------

### Example of trim_end_matches with a closure

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=u32+-%3E+bool

Repeatedly removes characters matching a predicate from the end of a string.

```rust
assert_eq!("123foo1bar123".trim_end_matches(char::is_numeric), "123foo1bar");
```

--------------------------------

### Trim Start Matches with Numeric Pattern

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Address.html?search=std%3A%3Avec

Removes all prefixes that match a numeric character.

```rust
assert_eq!("123foo1bar123".trim_start_matches(char::is_numeric), "foo1bar123");
```

--------------------------------

### hat_on

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.ApiNoContext.html?search=std%3A%3Avec

Turns on the HAT (Hardware Access Terminal) module.

```APIDOC
## hat_on

### Description
Turns on the HAT (Hardware Access Terminal) module.

### Method
POST (assumed, as it's a control operation)

### Endpoint
`/hat/on`

### Response
#### Success Response (200)
- **HatOnResponse** - The response indicating the HAT has been turned on.
```

--------------------------------

### Trim Start Matches with Character Pattern

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Address.html?search=std%3A%3Avec

Removes all prefixes that match a given character.

```rust
assert_eq!("11foo1bar11".trim_start_matches('1'), "foo1bar11");
```

--------------------------------

### Reverse Split Example with Simple Patterns

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=

Splits a string slice by a pattern and yields substrings in reverse order. Handles various simple patterns like characters and string slices.

```rust
let v: Vec<&str> = "Mary had a little lamb".rsplit(' ').collect();
assert_eq!(v, ["lamb", "little", "a", "had", "Mary"]);
```

```rust
let v: Vec<&str> = "".rsplit('X').collect();
assert_eq!(v, [""]);
```

```rust
let v: Vec<&str> = "lionXXtigerXleopard".rsplit('X').collect();
assert_eq!(v, ["leopard", "tiger", "", "lion"]);
```

```rust
let v: Vec<&str> = "lion::tiger::leopard".rsplit("::").collect();
assert_eq!(v, ["leopard", "tiger", "lion"]);
```

--------------------------------

### hat_on

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.ApiNoContext.html?search=u32+-%3E+bool

Turns on the HAT (Hardware Access Terminal) module. This is an asynchronous operation.

```APIDOC
## hat_on

### Description
Turns on the HAT (Hardware Access Terminal) module.

### Method
Asynchronous function call (within the ApiNoContext trait).

### Response
- **Result<HatOnResponse, ApiError>** - A future that resolves to either a successful HatOnResponse or an ApiError.
```

--------------------------------

### Get MBUS API Information

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.Api.html

Retrieves general information about the MBUS API. Requires only a context.

```rust
fn mbus_api<'life0, 'life1, 'async_trait>(
        &'life0 self,
        context: &'life1 C,
    ) -> Pin<Box<dyn Future<Output = Result<MbusApiResponse, ApiError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
```

--------------------------------

### get

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Address.html?search=

Safely retrieves a subslice of a string. Returns `None` if the indexing operation would panic.

```APIDOC
## get

### Description
Safely retrieves a subslice of a string. This is the non-panicking alternative to indexing the `str`. Returns `None` whenever equivalent indexing operation would panic.

### Method
`get<I>(&self, i: I) -> Option<&<I as SliceIndex<str>>::Output>`

### Parameters
#### Path Parameters
- **i** (`I` where `I: SliceIndex<str>`) - Required - The range or index to slice.

### Response
#### Success Response (Option<&<I as SliceIndex<str>>::Output>)
- Returns `Some` containing a string slice if the index is valid and within bounds.
- Returns `None` if the index is out of bounds or not on a UTF-8 sequence boundary.

### Examples
```rust
let v = String::from("🗻∈🌏");

assert_eq!(Some("🗻"), v.get(0..4));

// indices not on UTF-8 sequence boundaries
assert!(v.get(1..).is_none());
assert!(v.get(..8).is_none());

// out of bounds
assert!(v.get(..42).is_none());
```
```

--------------------------------

### Api::hat_on

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.Api.html?search=std%3A%3Avec

Turns on the HAT module.

```APIDOC
## Api::hat_on

### Description
Turns on the HAT module.

### Method
`hat_on`

### Parameters
- **context** (C) - Description not provided.

### Response
- **Success Response**: `HatOnResponse`
- **Error Response**: `ApiError`
```

--------------------------------

### Service as a Service Implementation

Source: https://docs.rs/mbus-api/latest/mbus_api/server/struct.Service.html?search=

Implementation of the Service trait for Service<T, C>, defining Response, Error, and Future types, and methods for polling readiness and calling the service.

```rust
type Response = Response<Body>
type Error = Box<dyn Error + Sync + Send>
type Future = Pin<Box<dyn Future<Output = Result<Response<Body>, Box<dyn Error + Sync + Send>>> + Send>>

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

fn call(&mut self, req: (Request<Body>, C)) -> Self::Future
```

--------------------------------

### Get Device Data

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html?search=

Retrieves data from a specific device with specified baud rate and address.

```APIDOC
## get

### Description
Retrieves data from a specific device.

### Method
GET (assumed, based on function name and return type)

### Endpoint
Not explicitly defined, but implies a GET request to a resource related to the device.

### Parameters
#### Path Parameters
None explicitly defined.

#### Query Parameters
None explicitly defined.

#### Request Body
None explicitly defined.

### Parameters
- **param_device** (String) - Required - The identifier of the device.
- **param_baudrate** (Baudrate) - Required - The baud rate for communication.
- **param_address** (String) - Required - The address of the device.
- **context** (C) - Required - The context for the request, likely containing session or request-specific information.

### Response
#### Success Response (200)
- **GetResponse** - The response containing the retrieved data.
```

--------------------------------

### Get TypeId of self

Source: https://docs.rs/mbus-api/latest/mbus_api/client/enum.HyperClient.html?search=std%3A%3Avec

Retrieves the `TypeId` of the current instance. This is useful for runtime type identification.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### Create HTTPS Client

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html

Creates a client with a TLS connection to the server. Use this for secure connections.

```rust
pub fn try_new_https(base_path: &str) -> Result<Self, ClientInitError>
```

--------------------------------

### Trim Start with Directionality

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=std%3A%3Avec

Demonstrates trimming leading whitespace from a string, considering text directionality.

```Rust
let s = "  English  ";
assert!(Some('E') == s.trim_start().chars().next());
```

--------------------------------

### MakeAddContext::new

Source: https://docs.rs/mbus-api/latest/mbus_api/context/struct.MakeAddContext.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Constructor for the MakeAddContext struct. It initializes the context with an inner service.

```APIDOC
## MakeAddContext::new

### Description
Creates a new `MakeAddContext` instance with the given inner service.

### Signature
```rust
pub fn new(inner: T) -> MakeAddContext<T, A>
```

### Parameters
* `inner`: The inner service of type `T` to be wrapped.
```

--------------------------------

### is_char_boundary()

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=std%3A%3Avec

Checks if a given byte index is the start of a UTF-8 character sequence or the end of the string.

```APIDOC
## is_char_boundary(index: usize)

### Description
Checks that the `index`-th byte is the first byte in a UTF-8 code point sequence or the end of the string. Returns `false` if `index` is greater than the string's length.

### Method
GET

### Endpoint
`/string/is_char_boundary`

### Parameters
#### Query Parameters
- **index** (usize) - Required - The byte index to check.

### Response
#### Success Response (200)
- **is_boundary** (bool) - `true` if the index is a character boundary, `false` otherwise.

### Response Example
{
  "is_boundary": true
}
```

--------------------------------

### Service Implementation for MakeAddContext

Source: https://docs.rs/mbus-api/latest/mbus_api/context/struct.MakeAddContext.html?search=

Details the implementation of the `Service` trait for `MakeAddContext`, outlining how it processes requests and handles responses asynchronously.

```APIDOC
## Service for MakeAddContext

### Description
This section details the implementation of the `Service` trait for the `MakeAddContext` struct. It defines how requests are processed and what types of responses and errors can be expected.

### Type Aliases
* **Error**: `<T as Service<Target>>::Error` - Errors produced by the underlying service.
* **Response**: `AddContext<<T as Service<Target>>::Response, A, B, C, D>` - The response type after context has been added.
* **Future**: `Pin<Box<dyn Future<Output = Result<<MakeAddContext<T, A> as Service<Target>>::Response, <MakeAddContext<T, A> as Service<Target>>::Error>> + Send>>` - The future representing the asynchronous operation.

### Methods
#### poll_ready

##### Description
Checks if the service is ready to process requests. Returns `Poll::Ready(Ok(()))` when the service is able to process requests.

##### Signature
```rust
fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>
```

#### call

##### Description
Processes the request and returns the response asynchronously.

##### Signature
```rust
fn call(&mut self, target: Target) -> Self::Future
```

##### Parameters
* **target** (Target) - The request target to process.
```

--------------------------------

### Trim End Example (Hebrew)

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Yaml.html?search=std%3A%3Avec

Demonstrates removing trailing whitespace from a string containing Hebrew characters.

```rust
let s = "  עברית  ";
assert!(Some('ת') == s.trim_end().chars().rev().next());
```

--------------------------------

### MakeAddContext::new

Source: https://docs.rs/mbus-api/latest/mbus_api/context/struct.MakeAddContext.html?search=

Constructs a new MakeAddContext instance. This is the primary way to create a MakeAddContext object, initializing it with an inner service.

```APIDOC
## MakeAddContext::new

### Description
Constructs a new `MakeAddContext` instance, initializing it with an inner service.

### Signature
```rust
pub fn new(inner: T) -> MakeAddContext<T, A>
```

### Parameters
* **inner** (T) - The inner service to wrap with context-aware functionality.
```

--------------------------------

### splitn with Simple Patterns

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.MbusData.html?search=u32+-%3E+bool

Illustrates `splitn` with character and string slice patterns, limiting the number of splits.

```rust
let v: Vec<&str> = "Mary had a little lambda".splitn(3, ' ').collect();
assert_eq!(v, ["Mary", "had", "a little lambda"]);
```

```rust
let v: Vec<&str> = "lionXXtigerXleopard".splitn(3, "X").collect();
assert_eq!(v, ["lion", "", "tigerXleopard"]);
```

```rust
let v: Vec<&str> = "abcXdef".splitn(1, 'X').collect();
assert_eq!(v, ["abcXdef"]);
```

```rust
let v: Vec<&str> = "".splitn(1, 'X').collect();
assert_eq!(v, [""]);
```

--------------------------------

### rsplit_once Examples

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=std%3A%3Avec

Demonstrates splitting a string on the last occurrence of a delimiter. Returns None if the delimiter is not found.

```rust
assert_eq!("cfg".rsplit_once('='), None);
assert_eq!("cfg=foo".rsplit_once('='), Some(("cfg", "foo")));
assert_eq!("cfg=foo=bar".rsplit_once('='), Some(("cfg=foo", "bar")));
```

--------------------------------

### Turn HAT On

Source: https://docs.rs/mbus-api/latest/mbus_api/client/struct.Client.html?search=

Turns on the HAT (Hardware Attached on Top) device.

```APIDOC
## hat_on

### Description
Turns on the HAT device.

### Method
POST or PUT (assumed, as it modifies state)

### Endpoint
Not explicitly defined, but implies a request to a HAT control resource.

### Parameters
#### Path Parameters
None explicitly defined.

#### Query Parameters
None explicitly defined.

#### Request Body
None explicitly defined.

### Parameters
- **context** (C) - Required - The context for the request.

### Response
#### Success Response (200)
- **HatOnResponse** - The response confirming the HAT has been turned on.
```

--------------------------------

### split_once Examples

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Device.html?search=std%3A%3Avec

Demonstrates splitting a string on the first occurrence of a delimiter. Returns None if the delimiter is not found.

```rust
assert_eq!("cfg".split_once('='), None);
assert_eq!("cfg=".split_once('='), Some(("cfg", "")));
assert_eq!("cfg=foo".split_once('='), Some(("cfg", "foo")));
assert_eq!("cfg=foo=bar".split_once('='), Some(("cfg", "foo=bar")));
```

--------------------------------

### strip_prefix

Source: https://docs.rs/mbus-api/latest/mbus_api/models/struct.Address.html

Removes a prefix from a string slice if it exists. Returns None if the string does not start with the specified prefix.

```APIDOC
## strip_prefix

### Description
Returns a string slice with the prefix removed. If the string starts with the pattern `prefix`, returns the substring after the prefix, wrapped in `Some`. Unlike `trim_start_matches`, this method removes the prefix exactly once. If the string does not start with `prefix`, returns `None`.

### Method
`strip_prefix<P>(&self, prefix: P) -> Option<&str>` where P: Pattern

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (Some)
- **&str** - The substring after the prefix.

#### Response Example
```rust
assert_eq!("foo:bar".strip_prefix("foo:"), Some("bar"));
assert_eq!("foo:bar".strip_prefix("bar"), None);
assert_eq!("foofoo".strip_prefix("foo"), Some("foo"));
```
```

--------------------------------

### hat_on

Source: https://docs.rs/mbus-api/latest/mbus_api/trait.ApiNoContext.html

Turns on the HAT (Hardware Access Technology) on the MBus device.

```APIDOC
## hat_on

### Description
Turns on the HAT (Hardware Access Technology) on the MBus device.

### Method
Not specified (likely asynchronous call within the trait)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **HatOnResponse** (type) - The response confirming the HAT is turned on.

#### Response Example
None
```
Tokens:
Raw