trawldb

https://docs.rs/trawldb/latest/trawldb/
Admin
Documentation for a software project, likely covering API clients and resource management.
Tokens:20,606
Snippets:278
Trust Score:9.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get All Resources

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Retrieves all resources as a HashMap of key-value pairs.

```rust
pub async fn resources(&self) -> Result<HashMap<String, String>>

```

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

### Client::listen_props_change() Example

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html?search=

Asynchronously listens for changes in properties and uses a callback to perform actions. The callback receives the property name and its new value.

```rust
use zbus::zvariant::Value;
async {
    let client = trawldb::Client::new().await.unwrap();
    let mut callback = |s:String, v: Value| println!(ירת{s} {:#?}, v);
    client.listen_props_change(callback);
};
```

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

### Get Resource by Key

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Retrieves a resource's value using its key.

```rust
pub async fn get_resource(&self, key: &str) -> Result<String>

```

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

### impl Type for ResourceManagerProxyBlocking<'p>

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Provides a method to get the zbus::zvariant::Signature for ResourceManagerProxyBlocking.

```rust
fn signature() -> Signature<'static>
```

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

### Client::run

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html

Executes the client with the provided command-line arguments. This is an asynchronous operation.

```APIDOC
## Client::run

### Description
Executes the client with the provided command-line arguments. This is an asynchronous operation.

### Method
`async fn run(&self, args: &CliArgs) -> Result<(), Box<dyn Error>>`

### Parameters
- **self**: A reference to the `Client` instance.
- **args**: A reference to `CliArgs` containing the command-line arguments.

### Response
- **Success Response**: An empty `Result` on success, or a `Box<dyn Error>` on failure.

### Example
```rust
// Assuming CliArgs is defined elsewhere
// let args = CliArgs { ... }; 
// let client = trawldb::Client::new().await.unwrap();
// client.run(&args).await.unwrap();
```
```

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

### Get Properties Changed Signal

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html

Asynchronously retrieves the PropertiesChanged signal.

```rust
pub async fn get_props_changed_signal( &self,
) -> Result<PropertiesChanged, Box<dyn Error>>
```

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

### Client::new

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html

Creates a new instance of the Client. This is an asynchronous operation.

```APIDOC
## Client::new

### Description
Creates a new instance of the Client. This is an asynchronous operation.

### Method
`async fn new() -> Result<Client<'a>, Box<dyn Error>>`

### Parameters
None

### Response
- **Success Response**: A `Result` containing a `Client` instance on success, or a `Box<dyn Error>` on failure.

### Example
```rust
use zbus::zvariant::Value;
async {
    let client = trawldb::Client::new().await.unwrap();
};
```
```

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

### CloneToUninit Implementation

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Implements the experimental clone_to_uninit method for ResourceManagerProxy.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)

```

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

### Get ArgGroup ID for CliArgs

Source: https://docs.rs/trawldb/latest/trawldb/parser/struct.CliArgs.html?search=std%3A%3Avec

Reports the `ArgGroup::id` for the set of arguments defined by CliArgs. This is useful for organizing and identifying argument groups.

```rust
fn group_id() -> Option<Id>
```

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

### Client::run

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html?search=std%3A%3Avec

Executes the client with the provided command-line arguments. This is an asynchronous operation that may return an error.

```APIDOC
## pub async fn run(&self, args: &CliArgs) -> Result<(), Box<dyn Error>>

### Description
Executes the client with the provided command-line arguments.

### Method
`async fn run(args: &CliArgs)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **args** (CliArgs) - Required - The command-line arguments to run the client with.

### Returns
A `Result` indicating success or failure.
```

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

### Client::run

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html?search=

Executes the client with the provided command-line arguments. This is an asynchronous operation that may return an error.

```APIDOC
## Client::run

### Description
Executes the client with the provided command-line arguments. This is an asynchronous operation that may return an error.

### Method
`async fn run(&self, args: &CliArgs) -> Result<(), Box<dyn Error>>`

### Parameters
- `&self`: An immutable reference to the Client instance.
- `args`: A reference to `CliArgs` containing the command-line arguments.

### Response
- **Success Response**: `Ok(())` indicating the client ran successfully.
- **Error Response**: A `Result` containing a `Box<dyn Error>` on failure.
```

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

### Client::run() Implementation

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html?search=

Asynchronously runs the client with the provided CLI arguments. Returns a Result indicating success or an error.

```rust
pub async fn run(&self, args: &CliArgs) -> Result<(), Box<dyn Error>>
```

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

### ResourceManagerProxyBlocking::new

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new ResourceManagerProxyBlocking with the default service and path.

```rust
pub fn new(conn: &Connection) -> Result<ResourceManagerProxyBlocking<'p>>

```

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

### ResourceManagerProxyBlocking::new

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Creates a new ResourceManagerProxyBlocking with the default service and path. Requires a Connection object.

```rust
pub fn new(conn: &Connection) -> Result<ResourceManagerProxyBlocking<'p>>
```

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

### Client::new

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html?search=std%3A%3Avec

Creates a new instance of the Client. This is an asynchronous operation that may return an error.

```APIDOC
## pub async fn new() -> Result<Client<'a>, Box<dyn Error>>

### Description
Creates a new instance of the `Client`.

### Method
`async fn new()`

### Returns
A `Result` containing the `Client` instance on success, or a `Box<dyn Error>` on failure.
```

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

### Client::new

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html?search=

Creates a new instance of the Client. This is an asynchronous operation that may return an error.

```APIDOC
## Client::new

### Description
Creates a new instance of the Client. This is an asynchronous operation that may return an error.

### Method
`async fn new() -> Result<Client<'a>, Box<dyn Error>>`

### Parameters
None

### Response
- **Success Response**: A `Result` containing a `Client` instance on success.
- **Error Response**: A `Result` containing a `Box<dyn Error>` on failure.
```

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

### Client::new

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

Creates a new instance of the Client. This is an asynchronous operation that may return an error.

```APIDOC
## Client::new

### Description
Creates a new instance of the `Client`. This is an asynchronous operation.

### Method
`async fn new() -> Result<Client<'a>, Box<dyn Error>>`

### Parameters
None

### Response
- `Ok(Client<'a>)`: A new `Client` instance.
- `Err(Box<dyn Error>)`: An error if the client could not be created.
```

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

### ResourceManagerProxy::new

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new ResourceManagerProxy with the default service and path. Requires an active Connection.

```rust
pub async fn new(conn: &Connection) -> Result<ResourceManagerProxy<'p>>
```

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

### Create ResourceManagerProxy

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Creates a new ResourceManagerProxy with the default service and path using an existing connection.

```rust
pub async fn new(conn: &Connection) -> Result<ResourceManagerProxy<'p>>

```

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

### ResourceManagerProxy::new

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=u32+-%3E+bool

Creates a new ResourceManagerProxy with a default service and path, requiring an active database connection.

```APIDOC
## ResourceManagerProxy::new

### Description
Creates a new proxy with the default service and path.

### Method
`async fn new(conn: &Connection) -> Result<ResourceManagerProxy<'p>>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let conn = Connection::connect("...").await?;
let proxy = ResourceManagerProxy::new(&conn).await?;
```

### Response
#### Success Response
- **ResourceManagerProxy<'p>** - A new instance of ResourceManagerProxy.

#### Response Example
```rust
// Success returns ResourceManagerProxy<'p>
```

#### Error Response
- **Result** - Indicates success or failure of the operation.
```

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

### ResourceManagerProxy::new

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=std%3A%3Avec

Creates a new ResourceManagerProxy instance with a given connection.

```APIDOC
## ResourceManagerProxy::new

### Description
Creates a new proxy with the default service and path.

### Method
`async fn new(conn: &Connection) -> Result<ResourceManagerProxy<'p>>`

### Parameters
#### Path Parameters
- **conn** (*&Connection*) - Required - The connection to use for creating the proxy.
```

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

### Client::new() Implementation

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html?search=

Asynchronously creates a new Client instance. Returns a Result containing the Client or a Boxed Error.

```rust
pub async fn new() -> Result<Client<'a>, Box<dyn Error>>
```

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

### ResourceManagerProxyBlocking::load_cpp

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Loads a resource with C++ specific parameters. Requires path, cpp, and args.

```rust
pub fn load_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>

```

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

### ResourceManagerProxyBlocking::load_cpp

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Loads a resource using C++ specific parameters. Requires path, cpp, and args.

```rust
pub fn load_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>
```

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

### Add Resource

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Adds a new resource with a key-value pair.

```rust
pub async fn add_resource(&self, key: String, value: String) -> Result<()>

```

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

### ResourceManagerProxy::load

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=

Loads a resource from the specified path. The `nocpp` flag controls C++ preprocessor behavior.

```APIDOC
## ResourceManagerProxy::load

### Description
Loads a resource from the specified path. The `nocpp` flag controls C++ preprocessor behavior.

### Method
`async fn load(&self, path: &str, nocpp: bool) -> Result<()>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let conn = Connection::system().await?;
let proxy = ResourceManagerProxy::new(&conn).await?;
proxy.load("/path/to/resource", false).await?;
```

### Response
#### Success Response (Result)
- `()`: Indicates successful loading.

#### Response Example
```rust
// On success, returns Ok(())
// On failure, returns Err(zbus::Error)
```
```

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

### ResourceManagerProxy::query

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Executes a query against the resource manager and returns the result as a String. The query string 'q' specifies the query to perform.

```rust
pub async fn query(&self, q: &str) -> Result<String>
```

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

### ResourceManagerProxyBlocking::load

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Loads a resource from the specified path. Requires nocpp parameter.

```rust
pub fn load(&self, path: &str, nocpp: bool) -> Result<()>

```

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

### ResourceManagerProxy::load_cpp

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=std%3A%3Avec

Loads a C++ resource from the specified path with custom C++ and arguments.

```APIDOC
## ResourceManagerProxy::load_cpp

### Description
Loads a C++ resource from the specified path with custom C++ and arguments.

### Method
`async fn load_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>`

### Parameters
#### Path Parameters
- **path** (*&str*) - Required - The path of the resource to load.
- **cpp** (*&str*) - Required - The C++ identifier.
- **args** (*&str*) - Required - The arguments for the C++ resource.
```

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

### ResourceManagerProxy::load

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Loads resources from a specified path. The 'nocpp' parameter controls C++ preprocessor behavior.

```rust
pub async fn load(&self, path: &str, nocpp: bool) -> Result<()>
```

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

### ResourceManagerProxyBlocking::query

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Executes a query and returns the result as a String.

```rust
pub fn query(&self, q: &str) -> Result<String>

```

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

### ResourceManagerProxy::load

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=std%3A%3Avec

Loads a resource from the specified path.

```APIDOC
## ResourceManagerProxy::load

### Description
Loads a resource from the specified path.

### Method
`async fn load(&self, path: &str, nocpp: bool) -> Result<()>`

### Parameters
#### Path Parameters
- **path** (*&str*) - Required - The path of the resource to load.
- **nocpp** (*bool*) - Required - Flag to indicate whether to skip C++ processing.
```

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

### Query Resource

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Executes a query against the resources and returns the result as a String.

```rust
pub async fn query(&self, q: &str) -> Result<String>

```

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

### impl Serialize for ResourceManagerProxyBlocking<'p>

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Enables serialization of ResourceManagerProxyBlocking instances using Serde.

```rust
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,
```

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

### ResourceManagerProxyBlocking::query

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Executes a query string and returns the result as a String.

```rust
pub fn query(&self, q: &str) -> Result<String>
```

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

### Build Clap Command for CliArgs instantiation

Source: https://docs.rs/trawldb/latest/trawldb/parser/struct.CliArgs.html?search=std%3A%3Avec

Builds a Clap `Command` object that can be used to instantiate a `CliArgs` struct.

```rust
fn command<'b>() -> Command
```

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

### ResourceManagerProxyBlocking::load

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Loads a resource from the specified path. The nocpp parameter may affect preprocessing.

```rust
pub fn load(&self, path: &str, nocpp: bool) -> Result<()>
```

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

### ResourceManagerProxy::load_cpp

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Loads resources from a specified path, with explicit C++ code and arguments. This method is for advanced usage involving C++ integration.

```rust
pub async fn load_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>
```

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

### ResourceManagerProxy::get_resource

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves a specific resource by its key. Returns the resource's value as a String.

```rust
pub async fn get_resource(&self, key: &str) -> Result<String>
```

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

### ResourceManagerProxy::load

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=u32+-%3E+bool

Loads a resource from the specified path, with an option to disable C++ pre-processing.

```APIDOC
## ResourceManagerProxy::load

### Description
Loads a resource from the specified path. The `nocpp` parameter controls whether C++ pre-processing is enabled.

### Method
`async fn load(&self, path: &str, nocpp: bool) -> Result<()>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let conn = Connection::connect("...").await?;
let proxy = ResourceManagerProxy::new(&conn).await?;
proxy.load("/path/to/resource", false).await?;
```

### Response
#### Success Response
- **()** - Indicates successful loading.

#### Response Example
```rust
// Success returns an empty tuple `()`
```

#### Error Response
- **Result** - Indicates success or failure of the operation.
```

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

### Load Resource

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Loads a resource from the specified path. The 'nocpp' parameter controls C++ preprocessor behavior.

```rust
pub async fn load(&self, path: &str, nocpp: bool) -> Result<()>

```

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

### Client::proxy() Implementation

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html?search=

Returns a reference to the ResourceManagerProxy associated with the client.

```rust
pub fn proxy(&self) -> &ResourceManagerProxy<'_>
```

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

### impl ProxyImpl<'p> for ResourceManagerProxyBlocking<'p>

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Provides the builder, into_inner, and inner methods for ResourceManagerProxyBlocking, common to proxy implementations.

```rust
fn builder(conn: &Connection) -> Builder<'p, Self>
```

```rust
fn into_inner(self) -> Proxy<'p>
```

```rust
fn inner(&self) -> &Proxy<'p>
```

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

### ResourceManagerProxyBlocking::get_resource

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves a resource by its key and returns it as a String.

```rust
pub fn get_resource(&self, key: &str) -> Result<String>

```

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

### ResourceManagerProxyBlocking::get_resource

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Retrieves a resource by its key and returns it as a String.

```rust
pub fn get_resource(&self, key: &str) -> Result<String>
```

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

### ResourceManagerProxyBlocking Methods

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides methods for creating, building, and accessing the underlying zbus::Proxy, as well as performing resource management operations.

```APIDOC
## ResourceManagerProxyBlocking

### Description
Represents a blocking proxy for managing resources.

### Methods

#### `new(conn: &Connection) -> Result<ResourceManagerProxyBlocking<'p>>`
Creates a new proxy with the default service and path.

#### `builder(conn: &Connection) -> Builder<'p, Self>`
Returns a customizable builder for this proxy.

#### `into_inner(self) -> Proxy<'p>`
Consumes `self`, returning the underlying `zbus::Proxy`.

#### `inner(&self) -> &Proxy<'p>`
Returns a reference to the underlying `zbus::Proxy`.

#### `inner_mut(&mut self) -> &mut Proxy<'p>`
Returns a mutable reference to the underlying `zbus::Proxy`.

#### `load(&self, path: &str, nocpp: bool) -> Result<()>`
Loads a resource from the specified path. `nocpp` indicates whether to skip C preprocessor.

#### `merge(&self, path: &str, nocpp: bool) -> Result<()>`
Merges a resource from the specified path. `nocpp` indicates whether to skip C preprocessor.

#### `load_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>`
Loads a resource from the specified path, with C preprocessor options.

#### `merge_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>`
Merges a resource from the specified path, with C preprocessor options.

#### `query(&self, q: &str) -> Result<String>`
Executes a query against the resources and returns the result as a string.

#### `get_resource(&self, key: &str) -> Result<String>`
Retrieves the value of a specific resource identified by its key.

#### `set_resource(&self, key: String, value: String) -> Result<()>`
Sets the value of a specific resource identified by its key.

#### `add_resource(&self, key: String, value: String) -> Result<()>`
Adds a new resource with the given key and value.

#### `quit(&self) -> Result<()>`
Initiates a quit operation.

#### `remove_one(&self, key: &str) -> Result<()>`
Removes a single resource identified by its key.

#### `remove_all(&self) -> Result<()>`
Removes all resources.

#### `resources(&self) -> Result<HashMap<String, String>>`
Retrieves all resources as a HashMap.
```

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

### ResourceManagerProxy::inner

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=std%3A%3Avec

Provides a reference to the underlying zbus::Proxy.

```APIDOC
## ResourceManagerProxy::inner

### Description
The reference to the underlying `zbus::Proxy`.

### Method
`fn inner(&self) -> &Proxy<'p>`
```

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

### Try to parse CLI arguments using std::env::args_os

Source: https://docs.rs/trawldb/latest/trawldb/parser/struct.CliArgs.html?search=std%3A%3Avec

Attempts to parse command-line arguments from the operating system's environment. Returns a Result, yielding an error if parsing fails.

```rust
fn try_parse() -> Result<Self, Error>
```

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

### impl Debug for ResourceManagerProxyBlocking<'p>

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Provides a Debug implementation for ResourceManagerProxyBlocking, allowing it to be formatted for debugging purposes.

```rust
fn fmt(&self, f: &mut Formatter<'_>) -> Result
```

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

### ResourceManagerProxy Methods

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

This section details the public methods available on the ResourceManagerProxy for interacting with resources.

```APIDOC
## ResourceManagerProxy

### Description
Provides an interface for managing resources through a proxy.

### Methods

#### `new(conn: &Connection) -> Result<ResourceManagerProxy<'p>>`
Creates a new proxy with the default service and path.

#### `builder(conn: &Connection) -> Builder<'p, Self>`
Returns a customizable builder for this proxy.

#### `into_inner(self) -> Proxy<'p>`
Consumes `self`, returning the underlying `zbus::Proxy`.

#### `inner(&self) -> &Proxy<'p>`
Returns a reference to the underlying `zbus::Proxy`.

#### `inner_mut(&mut self) -> &mut Proxy<'p>`
Returns a mutable reference to the underlying `zbus::Proxy`.

#### `load(&self, path: &str, nocpp: bool) -> Result<()>`
Loads a resource from the specified path.

#### `merge(&self, path: &str, nocpp: bool) -> Result<()>`
Merges a resource from the specified path.

#### `load_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>`
Loads a C++ resource from the specified path with given C++ arguments.

#### `merge_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>`
Merges a C++ resource from the specified path with given C++ arguments.

#### `query(&self, q: &str) -> Result<String>`
Queries for resources using the provided query string.

#### `get_resource(&self, key: &str) -> Result<String>`
Retrieves the value of a specific resource by its key.

#### `set_resource(&self, key: String, value: String) -> Result<()>`
Sets the value of a specific resource identified by its key.

#### `add_resource(&self, key: String, value: String) -> Result<()>`
Adds a new resource with the given key and value.

#### `quit(&self) -> Result<()>`
Initiates a quit operation.

#### `remove_one(&self, key: &str) -> Result<()>`
Removes a single resource identified by its key.

#### `remove_all(&self) -> Result<()>`
Removes all resources.

#### `resources(&self) -> Result<HashMap<String, String>>`
Retrieves all available resources as a HashMap.
```

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

### impl From<Proxy<'p>> for ResourceManagerProxyBlocking<'p>

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Allows creating a ResourceManagerProxyBlocking from an existing zbus::Proxy object.

```rust
fn from(proxy: Proxy<'p>) -> Self
```

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

### ResourceManagerProxy::resources

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves all currently managed resources as a HashMap where keys and values are Strings. This is an asynchronous operation.

```rust
pub async fn resources(&self) -> Result<HashMap<String, String>>
```

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

### Load C++ Resource

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Loads a resource with C++ preprocessor support, specifying the C++ compiler and arguments.

```rust
pub async fn load_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>

```

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

### ResourceManagerProxyBlocking::resources

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves all managed resources as a HashMap.

```rust
pub fn resources(&self) -> Result<HashMap<String, String>>

```

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

### ResourceManagerProxy::resources

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=std%3A%3Avec

Retrieves a map of all available resources.

```APIDOC
## ResourceManagerProxy::resources

### Description
Retrieves a map of all available resources.

### Method
`async fn resources(&self) -> Result<HashMap<String, String>>`
```

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

### ResourceManagerProxyBlocking::merge_cpp

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Merges a resource with C++ specific parameters. Requires path, cpp, and args.

```rust
pub fn merge_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>

```

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

### impl CloneToUninit for T

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Provides the clone_to_uninit method for types that implement Clone.

```rust
fn clone_to_uninit(&self) -> ::core::mem::MaybeUninit<Self>
```

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

### ResourceManagerProxyBlocking Methods

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=std%3A%3Avec

Provides methods for interacting with the resource manager through a blocking proxy. This includes creating proxies, loading and merging resources, querying, and managing individual resources.

```APIDOC
## ResourceManagerProxyBlocking

### Description
Represents a blocking proxy for interacting with the resource manager.

### Methods

#### `new(conn: &Connection) -> Result<ResourceManagerProxyBlocking<'p>>`
Creates a new proxy with the default service and path.

#### `builder(conn: &Connection) -> Builder<'p, Self>`
Returns a customizable builder for this proxy.

#### `into_inner(self) -> Proxy<'p>`
Consumes `self`, returning the underlying `zbus::Proxy`.

#### `inner(&self) -> &Proxy<'p>`
The reference to the underlying `zbus::Proxy`.

#### `inner_mut(&mut self) -> &mut Proxy<'p>`
The mutable reference to the underlying `zbus::Proxy`.

#### `load(&self, path: &str, nocpp: bool) -> Result<()>`
Loads a resource from the specified path.

#### `merge(&self, path: &str, nocpp: bool) -> Result<()>`
Merges a resource from the specified path.

#### `load_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>`
Loads a C++ resource from the specified path with given C++ arguments.

#### `merge_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>`
Merges a C++ resource from the specified path with given C++ arguments.

#### `query(&self, q: &str) -> Result<String>`
Queries the resource manager with the given query string.

#### `get_resource(&self, key: &str) -> Result<String>`
Retrieves the value of a resource associated with the given key.

#### `set_resource(&self, key: String, value: String) -> Result<()>`
Sets the value of a resource associated with the given key.

#### `add_resource(&self, key: String, value: String) -> Result<()>`
Adds a new resource with the given key and value.

#### `quit(&self) -> Result<()>`
Quits the resource manager.

#### `remove_one(&self, key: &str) -> Result<()>`
Removes a single resource identified by the key.

#### `remove_all(&self) -> Result<()>`
Removes all resources.

#### `resources(&self) -> Result<HashMap<String, String>>`
Retrieves all resources as a HashMap.
```

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

### ProxyImpl<'p> for ResourceManagerProxyBlocking

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Core proxy implementation methods for ResourceManagerProxyBlocking.

```rust
fn builder(conn: &Connection) -> Builder<'p, Self>

```

```rust
fn into_inner(self) -> Proxy<'p>

```

```rust
fn inner(&self) -> &Proxy<'p>

```

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

### ResourceManagerProxy::add_resource

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=std%3A%3Avec

Adds a new resource with a given key and value.

```APIDOC
## ResourceManagerProxy::add_resource

### Description
Adds a new resource with a given key and value.

### Method
`async fn add_resource(&self, key: String, value: String) -> Result<()>`

### Parameters
#### Path Parameters
- **key** (*String*) - Required - The key for the new resource.
- **value** (*String*) - Required - The value for the new resource.
```

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

### ResourceManagerProxyBlocking::merge_cpp

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Merges a resource using C++ specific parameters. Requires path, cpp, and args.

```rust
pub fn merge_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>
```

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

### Parse CLI arguments using std::env::args_os

Source: https://docs.rs/trawldb/latest/trawldb/parser/struct.CliArgs.html?search=std%3A%3Avec

Parses command-line arguments directly from the operating system's environment. Exits the program if parsing fails.

```rust
fn parse() -> Self
```

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

### ResourceManagerProxyBlocking Methods

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html

Provides methods for creating, loading, merging, querying, and managing resources through a blocking proxy interface.

```APIDOC
## ResourceManagerProxyBlocking

### Description
A blocking proxy for interacting with the resource manager.

### Methods

#### `new(conn: &Connection) -> Result<ResourceManagerProxyBlocking<'p>>`
Creates a new proxy with the default service and path.

#### `builder(conn: &Connection) -> Builder<'p, Self>`
Returns a customizable builder for this proxy.

#### `into_inner(self) -> Proxy<'p>`
Consumes `self`, returning the underlying `zbus::Proxy`.

#### `inner(&self) -> &Proxy<'p>`
Returns a reference to the underlying `zbus::Proxy`.

#### `inner_mut(&mut self) -> &mut Proxy<'p>`
Returns a mutable reference to the underlying `zbus::Proxy`.

#### `load(&self, path: &str, nocpp: bool) -> Result<()>`
Loads a resource from the specified path.

#### `merge(&self, path: &str, nocpp: bool) -> Result<()>`
Merges a resource from the specified path.

#### `load_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>`
Loads a C++ resource from the specified path with arguments.

#### `merge_cpp(&self, path: &str, cpp: &str, args: &str) -> Result<()>`
Merges a C++ resource from the specified path with arguments.

#### `query(&self, q: &str) -> Result<String>`
Queries the resource manager with the given query string.

#### `get_resource(&self, key: &str) -> Result<String>`
Retrieves the value of a specific resource by its key.

#### `set_resource(&self, key: String, value: String) -> Result<()>`
Sets the value of a specific resource identified by its key.

#### `add_resource(&self, key: String, value: String) -> Result<()>`
Adds a new resource with the given key and value.

#### `quit(&self) -> Result<()>`
Initiates a quit operation on the resource manager.

#### `remove_one(&self, key: &str) -> Result<()>`
Removes a single resource identified by its key.

#### `remove_all(&self) -> Result<()>`
Removes all resources managed by this proxy.

#### `resources(&self) -> Result<HashMap<String, String>>`
Retrieves all resources as a HashMap.
```

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

### Clone From Implementation for ResourceManagerProxy

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Implements the clone_from method for ResourceManagerProxy, performing copy-assignment from a source.

```rust
fn clone_from(&mut self, source: &Self)

```

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

### ResourceManagerProxy Trait Implementations

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Details the trait implementations for ResourceManagerProxy, showing its compatibility with other Rust features and libraries.

```APIDOC
## ResourceManagerProxy Trait Implementations

### `AsMut<Proxy<'p>>`
#### `as_mut(&mut self) -> &mut Proxy<'p>`
Converts this type into a mutable reference of the (usually inferred) input type.

### `AsRef<Proxy<'p>>`
#### `as_ref(&self) -> &Proxy<'p>`
Converts this type into a shared reference of the (usually inferred) input type.

### `Clone`
#### `clone(&self) -> ResourceManagerProxy<'p>`
Returns a duplicate of the value.
#### `clone_from(&mut self, source: &Self)`
Performs copy-assignment from `source`.

### `Debug`
#### `fmt(&self, f: &mut Formatter<'_>) -> Result`
Formats the value using the given formatter.

### `From<Proxy<'p>>`
#### `from(proxy: Proxy<'p>) -> Self`
Converts to this type from the input type.

### `ProxyDefault`
#### `INTERFACE: Option<&'static str>`
#### `DESTINATION: Option<&'static str>`
#### `PATH: Option<&'static str>`

### `ProxyImpl<'p>`
#### `builder(conn: &Connection) -> Builder<'p, Self>`
Returns a customizable builder for this proxy.
#### `into_inner(self) -> Proxy<'p>`
Consumes `self`, returning the underlying `zbus::Proxy`.
#### `inner(&self) -> &Proxy<'p>`
The reference to the underlying `zbus::Proxy`.

### `Serialize`
#### `serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>`
where S: Serializer,
Serialize this value into the given Serde serializer.

### `Type`
#### `signature() -> Signature<'static>`
Get the signature for the implementing type.
```

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

### impl<'a> Sync for Client<'a>

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

Implementation of the Sync trait for Client. Indicates that the client can be safely shared between threads.

```rust
impl<'a> Sync for Client<'a>
```

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

### ResourceManagerProxy ProxyDefault Path Constant

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Defines the default D-Bus path for the ResourceManagerProxy.

```rust
const PATH: Option<&'static str>
```

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

### impl CloneFrom for ResourceManagerProxyBlocking<'p>

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Enables copy-assignment from a source ResourceManagerProxyBlocking instance.

```rust
fn clone_from(&mut self, source: &Self)
```

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

### impl Clone for ResourceManagerProxyBlocking<'p>

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Allows cloning ResourceManagerProxyBlocking instances. Note: This is marked as unstable.

```rust
fn clone(&self) -> ResourceManagerProxyBlocking<'p>
```

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

### ResourceManagerProxyBlocking::resources

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Retrieves all managed resources as a HashMap where keys and values are Strings.

```rust
pub fn resources(&self) -> Result<HashMap<String, String>>
```

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

### impl AsRef<Proxy<'p>> for ResourceManagerProxyBlocking<'p>

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=u32+-%3E+bool

Provides immutable access to the inner Proxy object.

```rust
fn as_ref(&self) -> &Proxy<'p>
```

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

### ResourceManagerProxy::merge

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Merges resources from a specified path. The 'nocpp' parameter controls C++ preprocessor behavior.

```rust
pub async fn merge(&self, path: &str, nocpp: bool) -> Result<()>
```

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

### ProxyDefault Path Constant

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Defines the default path for ResourceManagerProxy.

```rust
const PATH: Option<&'static str>

```

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

### TryFrom Implementation

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html

Performs a fallible conversion from one type to another, returning a `Result`.

```rust
type Error = Infallible;
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
```

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

### ResourceManagerProxy::get_resource

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=std%3A%3Avec

Retrieves the value of a specific resource by its key.

```APIDOC
## ResourceManagerProxy::get_resource

### Description
Retrieves the value of a specific resource by its key.

### Method
`async fn get_resource(&self, key: &str) -> Result<String>`

### Parameters
#### Path Parameters
- **key** (*&str*) - Required - The key of the resource to retrieve.
```

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

### ResourceManagerProxyBlocking::add_resource

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Adds a new resource with a given key and value.

```rust
pub fn add_resource(&self, key: String, value: String) -> Result<()>

```

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

### ResourceManagerProxy Blanket Implementations

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=u32+-%3E+bool

Shows blanket implementations for traits like Any, Borrow, BorrowMut, CloneToUninit, and DynamicType, which are derived from the underlying zbus::Proxy or generic implementations.

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

```

```rust
fn borrow(&self) -> &T

```

```rust
fn borrow_mut(&mut self) -> &mut T

```

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)

```

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

### ResourceManagerProxy Clone Implementation

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=u32+-%3E+bool

Provides the ability to clone ResourceManagerProxy instances. This creates a new proxy instance pointing to the same underlying zbus proxy.

```rust
fn clone(&self) -> ResourceManagerProxy<'p>

```

```rust
fn clone_from(&mut self, source: &Self)

```

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

### Client::proxy

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html

Returns a reference to the ResourceManagerProxy associated with the client.

```APIDOC
## Client::proxy

### Description
Returns a reference to the ResourceManagerProxy associated with the client.

### Method
`fn proxy(&self) -> &ResourceManagerProxy<'_>`

### Parameters
- **self**: A reference to the `Client` instance.

### Response
- **Success Response**: A reference to a `ResourceManagerProxy`.

### Example
```rust
let client = trawldb::Client::new().await.unwrap();
let proxy = client.proxy();
```
```

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

### Build Clap Command for CliArgs update

Source: https://docs.rs/trawldb/latest/trawldb/parser/struct.CliArgs.html?search=std%3A%3Avec

Builds a Clap `Command` object specifically for updating an existing `CliArgs` struct.

```rust
fn command_for_update<'b>() -> Command
```

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

### ResourceManagerProxy::inner

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=u32+-%3E+bool

Provides an immutable reference to the underlying zbus::Proxy.

```APIDOC
## ResourceManagerProxy::inner

### Description
The reference to the underlying `zbus::Proxy`.

### Method
`fn inner(&self) -> &Proxy<'p>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let conn = Connection::connect("...").await?;
let proxy = ResourceManagerProxy::new(&conn).await?;
let zbus_proxy_ref = proxy.inner();
```

### Response
#### Success Response
- **&Proxy<'p>** - An immutable reference to the underlying zbus::Proxy.

#### Response Example
```rust
// Returns a reference to the zbus::Proxy object
```
```

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

### ResourceManagerProxyBlocking::merge

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Merges a resource from the specified path. Requires nocpp parameter.

```rust
pub fn merge(&self, path: &str, nocpp: bool) -> Result<()>

```

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

### ResourceManagerProxyBlocking Search

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=

Provides methods to search and retrieve data through the ResourceManagerProxyBlocking interface. This includes functionalities for dynamic type signatures and cloning operations.

```APIDOC
## ResourceManagerProxyBlocking Search Operations

This section outlines the available search and manipulation methods for ResourceManagerProxyBlocking.

### `dynamic_signature`

*   **Description**: Retrieves the signature for the implementing type.
*   **Method**: N/A (Method call on an object)
*   **Parameters**: None
*   **Response**: `Signature<'_>` - The signature of the implementing type.

### `clone_to_uninit`

*   **Description**: Performs copy-assignment from `self` to `dest`. This is a nightly-only experimental API.
*   **Method**: N/A (Method call on an object)
*   **Parameters**:
    *   `dest` (*mut u8) - Required - A mutable pointer to the destination memory.
*   **Response**: None

### `instrument`

*   **Description**: Instruments this type with the provided `Span`, returning an `Instrumented` wrapper.
*   **Method**: N/A (Method call on an object)
*   **Parameters**:
    *   `span` (`Span`) - Required - The span to instrument with.
*   **Response**: `Instrumented<Self>` - An `Instrumented` wrapper of the type.

### `in_current_span`

*   **Description**: Instruments this type with the current `Span`, returning an `Instrumented` wrapper.
*   **Method**: N/A (Method call on an object)
*   **Parameters**: None
*   **Response**: `Instrumented<Self>` - An `Instrumented` wrapper of the type.

### `into`

*   **Description**: Calls `U::from(self)`. This conversion is determined by the implementation of `From<T> for U`.
*   **Method**: N/A (Method call on an object)
*   **Parameters**: None
*   **Response**: `U` - The converted type.

### `to_owned`

*   **Description**: Creates owned data from borrowed data, usually by cloning.
*   **Method**: N/A (Method call on an object)
*   **Parameters**: None
*   **Response**: `T` - An owned version of the data.

### `clone_into`

*   **Description**: Uses borrowed data to replace owned data, usually by cloning.
*   **Method**: N/A (Method call on an object)
*   **Parameters**:
    *   `target` (`&mut T`) - Required - A mutable reference to the target to clone into.
*   **Response**: None

### `try_from`

*   **Description**: Performs the conversion from `U` to `T`.
*   **Method**: N/A (Method call on an object)
*   **Parameters**:
    *   `value` (`U`) - Required - The value to convert.
*   **Response**: `Result<T, <T as TryFrom<U>>::Error>` - The result of the conversion.

### `try_into`

*   **Description**: Performs the conversion from `T` to `U`.
*   **Method**: N/A (Method call on an object)
*   **Parameters**: None
*   **Response**: `Result<U, <U as TryFrom<T>>::Error>` - The result of the conversion.

### `vzip`

*   **Description**: Zips the current type with a `MultiLane`.
*   **Method**: N/A (Method call on an object)
*   **Parameters**: None
*   **Response**: `V` - The zipped type.

### `with_subscriber`

*   **Description**: Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper.
*   **Method**: N/A (Method call on an object)
*   **Parameters**:
    *   `subscriber` (`S`) - Required - The subscriber to attach.
*   **Response**: `WithDispatch<Self>` - A wrapper with the attached subscriber.

### `with_current_subscriber`

*   **Description**: Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper.
*   **Method**: N/A (Method call on an object)
*   **Parameters**: None
*   **Response**: `WithDispatch<Self>` - A wrapper with the attached subscriber.

```

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

### ResourceManagerProxy::builder

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=std%3A%3Avec

Returns a customizable builder for creating a ResourceManagerProxy.

```APIDOC
## ResourceManagerProxy::builder

### Description
Returns a customizable builder for this proxy.

### Method
`fn builder(conn: &Connection) -> Builder<'p, Self>`

### Parameters
#### Path Parameters
- **conn** (*&Connection*) - Required - The connection to use for building the proxy.
```

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

### ResourceManagerProxy::into_inner

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=std%3A%3Avec

Consumes the ResourceManagerProxy and returns the underlying zbus::Proxy.

```APIDOC
## ResourceManagerProxy::into_inner

### Description
Consumes `self`, returning the underlying `zbus::Proxy`.

### Method
`fn into_inner(self) -> Proxy<'p>`
```

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

### ResourceManagerProxy::into_inner

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=u32+-%3E+bool

Consumes the ResourceManagerProxy and returns the underlying zbus::Proxy.

```APIDOC
## ResourceManagerProxy::into_inner

### Description
Consumes `self`, returning the underlying `zbus::Proxy`.

### Method
`fn into_inner(self) -> Proxy<'p>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let conn = Connection::connect("...").await?;
let proxy = ResourceManagerProxy::new(&conn).await?;
let zbus_proxy = proxy.into_inner();
```

### Response
#### Success Response
- **Proxy<'p>** - The underlying zbus::Proxy.

#### Response Example
```rust
// Returns the zbus::Proxy object
```
```

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

### Client Listen Properties Change

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

Listens for changes in properties using a callback function. The callback is invoked with the property name and its new value.

```rust
pub async fn listen_props_change<T>( &self, callback: T, ) -> Result<(), Box<dyn Error>>
where T: FnMut(String, Value<'_>),
Listen for changes in properties. Uses callback to perform required actions.
```

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

### Instantiate CliArgs from ArgMatches

Source: https://docs.rs/trawldb/latest/trawldb/parser/struct.CliArgs.html?search=std%3A%3Avec

Instantiates a CliArgs struct from Clap's `ArgMatches`, parsing arguments as needed. Returns a Result, yielding an error if instantiation fails.

```rust
fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
```

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

### Client Struct Definition

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html?search=

Defines the Client struct with private fields.

```rust
pub struct Client<'a> { /* private fields */ }
```

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

### ProxyImpl Builder Method

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Implements the builder method for ResourceManagerProxy as part of the ProxyImpl trait.

```rust
fn builder(conn: &Connection) -> Builder<'p, Self>

```

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

### ResourceManagerProxy::merge

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=

Merges a resource from the specified path. The `nocpp` flag controls C++ preprocessor behavior.

```APIDOC
## ResourceManagerProxy::merge

### Description
Merges a resource from the specified path. The `nocpp` flag controls C++ preprocessor behavior.

### Method
`async fn merge(&self, path: &str, nocpp: bool) -> Result<()>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let conn = Connection::system().await?;
let proxy = ResourceManagerProxy::new(&conn).await?;
proxy.merge("/path/to/resource", false).await?;
```

### Response
#### Success Response (Result)
- `()`: Indicates successful merging.

#### Response Example
```rust
// On success, returns Ok(())
// On failure, returns Err(zbus::Error)
```
```

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

### ResourceManagerProxy::query

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html?search=std%3A%3Avec

Queries the resource manager with a given query string.

```APIDOC
## ResourceManagerProxy::query

### Description
Queries the resource manager with a given query string.

### Method
`async fn query(&self, q: &str) -> Result<String>`

### Parameters
#### Path Parameters
- **q** (*&str*) - Required - The query string.
```

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

### Client::listen_props_change

Source: https://docs.rs/trawldb/latest/trawldb/struct.Client.html

Listens for changes in properties and executes a callback function when changes occur. This is an asynchronous operation.

```APIDOC
## Client::listen_props_change

### Description
Listens for changes in properties and executes a callback function when changes occur. This is an asynchronous operation.

### Method
`async fn listen_props_change<T>(&self, callback: T) -> Result<(), Box<dyn Error>> where T: FnMut(String, Value<'_>)

### Parameters
- **self**: A reference to the `Client` instance.
- **callback**: A mutable closure that takes a `String` (property name) and a `Value<'_>` (property value) as arguments.

### Response
- **Success Response**: An empty `Result` on success, or a `Box<dyn Error>` on failure.

### Example
```rust
use zbus::zvariant::Value;
async {
    let client = trawldb::Client::new().await.unwrap();
    let mut callback = |s:String, v: Value| println!("{s} {:#?}", v);
    client.listen_props_change(callback).await.unwrap();
};
```
```

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

### From<Proxy<'p>> for ResourceManagerProxyBlocking

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Implementation of the From trait, allowing conversion from a zbus::Proxy to ResourceManagerProxyBlocking.

```rust
fn from(proxy: Proxy<'p>) -> Self

```

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

### ResourceManagerProxyBlocking CloneToUninit Implementation

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=std%3A%3Avec

Blanket implementation of the CloneToUninit trait for ResourceManagerProxyBlocking.

```rust
// No specific function signature provided in the source for this blanket impl.

```

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

### impl<'a> Freeze for Client<'a>

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

Implementation of the Freeze trait for Client. Indicates that the client can be frozen.

```rust
impl<'a> Freeze for Client<'a>
```

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

### Quit ResourceManager

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxy.html

Initiates the quit process for the ResourceManager.

```rust
pub async fn quit(&self) -> Result<()>

```

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

### ResourceManagerProxyBlocking::inner

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides a reference to the underlying zbus::Proxy.

```rust
pub fn inner(&self) -> &Proxy<'p>

```

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

### ResourceManagerProxyBlocking::quit

Source: https://docs.rs/trawldb/latest/trawldb/manager/struct.ResourceManagerProxyBlocking.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initiates the quit process for the resource manager.

```rust
pub fn quit(&self) -> Result<()>

```
Tokens:
Raw