Komodo Client

https://docs.rs/komodo_client/latest/komodo_client/
Admin
A client library for the Komodo Core API, providing definitions for API entities and a client to...
Tokens:2,159,543
Snippets:27,675
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### StartDeployment

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.StartDeployment.html?search=std%3A%3Avec

Starts the container for the target deployment. Response: Update. Runs `docker start ${container_name}`.

```APIDOC
## StartDeployment

### Description
Starts the container for the target deployment. Response: Update. Runs `docker start ${container_name}`.

### Fields
- **deployment** (String) - Required - Name or id of the deployment.

### Response
- **Update** - The response type is Update.

```

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

### StartDeployment

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.StartDeployment.html

Starts the container for the target deployment. Runs 'docker start ${container_name}'. The response is an Update.

```APIDOC
## StartDeployment

### Description
Starts the container for the target deployment. Runs `docker start ${container_name}`. The response is an Update.

### Fields
- **deployment** (String) - Required - Name or id of the deployment.

### Response
- **type**: Update

```

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

### StartContainer

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.StartContainer.html?search=std%3A%3Avec

Starts the container on the target server. Runs `docker start ${container_name}`. Response: Update.

```APIDOC
## StartContainer

### Description
Starts the container on the target server. Runs `docker start ${container_name}`. Response: Update.

### Fields
- **server** (String) - Required - Name or id of the server.
- **container** (String) - Required - The container name.

### Response
- **Update** - The response type is `Update`.

### Trait Implementations
- `Args`
- `Clone`
- `CommandFactory`
- `Debug`
- `Deserialize`
- `FromArgMatches`
- `HasResponse` (Response = Update, Error = Error)
- `KomodoExecuteRequest`
- `Parser`
- `PartialEq`
- `Serialize`
- `StructuralPartialEq`
```

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

### StartContainer

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.StartContainer.html

Starts the container on the target server. Runs `docker start ${container_name}`. Response: Update.

```APIDOC
## StartContainer

### Description
Starts the container on the target server. Runs `docker start ${container_name}`. Response: Update.

### Fields
- **server** (String) - Required - Name or id of the server.
- **container** (String) - Required - The container name.

### Response
- **Update** - The response type is Update.

```

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

### with_capacity_in example with System allocator

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/docker/type.GenericResources.html?search=

Shows constructing a Vec with a custom allocator (System) using with_capacity_in. Demonstrates that the vector starts empty, can grow without reallocating up to capacity, and that zero-sized types always over-allocate.

```rust
#![feature(allocator_api)]

use std::alloc::System;

let mut vec = Vec::with_capacity_in(10, System);

// The vector contains no items, even though it has capacity for more
assert_eq!(vec.len(), 0);
assert!(vec.capacity() >= 10);

// These are all done without reallocating...
for i in 0..10 {
    vec.push(i);
}
assert_eq!(vec.len(), 10);
assert!(vec.capacity() >= 10);

// ...but this may make the vector reallocate
vec.push(11);
assert_eq!(vec.len(), 11);
assert!(vec.capacity() >= 11);

// A vector of a zero-sized type will always over-allocate, since no
// allocation is necessary
let vec_units = Vec::<(), System>::with_capacity_in(10, System);
assert_eq!(vec_units.capacity(), usize::MAX);
```

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

### StartContainer

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

Starts the container on the target server. Response: Update. Runs `docker start ${container_name}`.

```APIDOC
## StartContainer

### Description
Starts the container on the target server. Response: Update. Runs `docker start ${container_name}`.

### Fields
- **server** (String) - Required - Name or id
- **container** (String) - Required - The container name

### Response
- **Update** - The response type is Update.

```

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

### as_bytes example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html

Shows how to get a byte slice of a String using as_bytes. The example asserts the byte values of the string "hello".

```rust
let s = String::from("hello");

assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());

```

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

### StartStack

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=

Starts the target stack using `docker compose start`.

```APIDOC
## StartStack

### Description
Starts the target stack using `docker compose start`.

### Method
POST

### Endpoint
/execute/start-stack

### Parameters
#### Request Body
- **stack_id** (string) - Required - The ID of the stack.

### Request Example
{
  "stack_id": "stack-123"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

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

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

### StartStack

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Starts the target stack using `docker compose start`.

```APIDOC
## StartStack

### Description
Starts the target stack using `docker compose start`.

### Method
POST

### Endpoint
/execute/start-stack

### Parameters
#### Request Body
- **stack_id** (string) - Required - The ID of the stack to start.

### Request Example
{
  "stack_id": "stack-123"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

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

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

### StartStack

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=u32+-%3E+bool

Starts the target stack using `docker compose start`.

```APIDOC
## StartStack

### Description
Starts the target stack using `docker compose start`.

### Method
POST

### Endpoint
/execute/start-stack

### Parameters
#### Request Body
- **stack_id** (string) - Required - The ID of the stack to start.

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.

#### Response Example
{
  "status": "success"
}
```

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

### StartStack

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.StartStack.html?search=u32+-%3E+bool

Starts the target stack using `docker compose start`. The response is an Update.

```APIDOC
## StartStack

### Description
Starts the target stack. Uses `docker compose start`. Response: Update.

### Fields
- **stack** (String) - Required - Id or name of the stack.
- **services** (Vec<String>) - Optional - Filter to only start specific services. If empty, will start all services.

### Response
- **Update** - The response type is Update.

```

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

### StartStack

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.StartStack.html?search=

Starts the target stack using `docker compose start`. The response is an Update.

```APIDOC
## StartStack

### Description
Starts the target stack. `docker compose start`. Response: Update

### Fields
- **stack** (String) - Required - Id or name
- **services** (Vec<String>) - Required - Filter to only start specific services. If empty, will start all services.

### Response
- **Update** - The response type is Update.
```

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

### StartStack

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.StartStack.html

Starts the target stack using `docker compose start`. The response is an Update.

```APIDOC
## StartStack

### Description
Starts the target stack using `docker compose start`. The response is an Update.

### Fields
- **stack** (String) - Required - Id or name of the stack.
- **services** (Vec<String>) - Optional - Filter to only start specific services. If empty, will start all services.

### Response
- **Update** - The response type is Update.

```

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

### StartStack

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=std%3A%3Avec

Starts the target stack using `docker compose start`. Returns an Update response.

```APIDOC
## StartStack

### Description
Starts the target stack using `docker compose start`. Returns an Update response.

### Method
POST

### Endpoint
/StartStack

### Parameters
#### Path Parameters
- **stack_id** (string) - Required - The ID of the stack to start.

### Request Example
```json
{
  "stack_id": "stack-123"
}
```

### Response
#### Success Response (200)
- **status** (string) - The result of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### StartStack

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html

Starts the target stack using `docker compose start`. Returns an Update response.

```APIDOC
## StartStack

### Description
Starts the target stack using `docker compose start`. Returns an Update response.

### Command
`docker compose start`

### Response
Update

```

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

### Pattern field example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.BatchRunAction.html

Shows an example of the pattern field, supporting multiline and comma-delineated combinations. The example matches all foo-* actions and adds extra-action-1 and extra-action-2.

```text
# match all foo-* actions
foo-*
# add some more
extra-action-1, extra-action-2
```

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

### BatchDeploy pattern example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.BatchDeploy.html

Example pattern value for the BatchDeploy struct. Shows how to match all deployments with a wildcard pattern and add additional deployments using comma delineation.

```text
# match all foo-* deployments
foo-*
# add some more
extra-deployment-1, extra-deployment-2
```

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

### KomodoClient usage example

Source: https://docs.rs/komodo_client/latest/komodo_client/index.html?search=

Example of using KomodoClient to fetch deployments and run a build. Requires environment variables KOMODO_ADDRESS, KOMODO_API_KEY, and KOMODO_API_SECRET. Uses dotenvy to load .env file.

```rust
dotenvy::dotenv().ok();

let client = KomodoClient::new_from_env()?;

// Get all the deployments
let deployments = client.read(ListDeployments::default()).await?;

println!("{deployments:#?}");

let update = client.execute(RunBuild { build: "test-build".to_string() }).await?:
```

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

### Example input for parse_key_value_list

Source: https://docs.rs/komodo_client/latest/komodo_client/parsers/fn.parse_key_value_list.html?search=std%3A%3Avec

Example input string demonstrating supported formats: comments, end-of-line comments, quoted values, YAML list format, and outer quote removal.

```rust
# Supports comments
KEY_1 = value_1 # end of line comments

# Supports string wrapped values
KEY_2="value_2"
'KEY_3 = value_3'

# Also supports yaml list formats
- KEY_4: 'value_4'
- "KEY_5=value_5"

# Wrapping outer quotes are removed while inner quotes are preserved
"KEY_6 = 'value_6'"
```

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

### capacity example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html

Returns the capacity of the String in bytes. The example shows that capacity is at least the requested amount.

```rust
let s = String::with_capacity(10);

assert!(s.capacity() >= 10);
```

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

### Pattern example for BatchBuildRepo

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

Example pattern value for the pattern field. Supports multiline and comma delineated combinations, including wildcard patterns.

```text
# match all foo-* repos
foo-*
# add some more
extra-repo-1, extra-repo-2
```

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

### push example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html

Demonstrates appending characters to a String using push. The example pushes three characters and asserts the final string.

```rust
let mut s = String::from("abc");

s.push('1');
s.push('2');
s.push('3');

assert_eq!("abc123", s);

```

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

### Pattern field example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.BatchRunBuild.html?search=

Shows the syntax for the pattern field, supporting multiline and comma delineated combinations. The example matches all foo-* builds and adds extra-build-1 and extra-build-2.

```text
# match all foo-* builds
foo-*
# add some more
extra-build-1, extra-build-2
```

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

### shrink_to_fit example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html

Demonstrates shrink_to_fit, which reduces the capacity of a String to match its length. The example reserves capacity, then shrinks it and asserts the capacity equals 3.

```rust
let mut s = String::from("foo");

s.reserve(100);
assert!(s.capacity() >= 100);

s.shrink_to_fit();
assert_eq!(3, s.capacity());

```

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

### Example input for parse_string_list

Source: https://docs.rs/komodo_client/latest/komodo_client/parsers/fn.parse_string_list.html?search=

Example input string showing comment lines and comma-separated values. Lines starting with # are comments and are ignored.

```text
# supports comments
path/to/file1 # comment1
path/to/file2

# also supports comma seperated values
path/to/file3,path/to/file4
```

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

### Example query string for initializing terminal

Source: https://docs.rs/komodo_client/latest/komodo_client/api/terminal/struct.ConnectTerminalQuery.html?search=u32+-%3E+bool

Shows how to pass init parameters in a query string to initialize a terminal session when it doesn't exist.

```text
?…(query)&init[command]=bash&init[recreate]=DifferentCommand
```

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

### CreateOnboardingKey

Source: https://docs.rs/komodo_client/latest/komodo_client/api/write/index.html?search=u32+-%3E+bool

Admin only. Create a Server onboarding key. Response: CreateOnboardingKeyResponse.

```APIDOC
## CreateOnboardingKey

### Description
Admin only. Create a Server onboarding key. Response: CreateOnboardingKeyResponse.

### Method
POST

### Endpoint
/api/write/create_onboarding_key

### Parameters
#### Request Body
- **name** (string) - Required - The name of the key.
- **expires_at** (string) - Optional - The expiration date of the key.

### Response
#### Success Response (200)
- **CreateOnboardingKeyResponse** (object) - Contains the created key.

#### Response Example
{
  "key": "string"
}
```

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

### String::insert_str example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html

Inserts a string slice at a byte position. The example prepends "foo" to "bar" to get "foobar".

```rust
let mut s = String::from("bar");

s.insert_str(0, "foo");

assert_eq!("foobar", s);
```

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

### Vec::push_mut example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/type.BatchExecutionResponse.html?search=

Shows how to use push_mut to push a value and get a mutable reference to it, then modify it in place.

```rust
let last = vec.push_mut(3);
*last += 1;
assert_eq!(vec, [1, 2, 3, 4]);
```

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

### StartDeployment

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=std%3A%3Avec

Starts the container for the target deployment. Returns an Update response.

```APIDOC
## StartDeployment

### Description
Starts the container for the target deployment. Returns an Update response.

### Method
POST

### Endpoint
/StartDeployment

### Parameters
#### Path Parameters
- **deployment_id** (string) - Required - The ID of the deployment.

### Request Example
```json
{
  "deployment_id": "deployment-123"
}
```

### Response
#### Success Response (200)
- **status** (string) - The result of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### Vec::peek_mut example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/type.BatchExecutionResponse.html?search=

Uses the nightly-only `vec_peek_mut` feature to get a mutable reference to the last element, modify it, and verify the change. Requires `#![feature(vec_peek_mut)]`.

```rust
#![feature(vec_peek_mut)]
let mut vec = Vec::new();
assert!(vec.peek_mut().is_none());

vec.push(1);
vec.push(5);
vec.push(2);
assert_eq!(vec.last(), Some(&2));
if let Some(mut val) = vec.peek_mut() {
    *val = 0;
}
assert_eq!(vec.last(), Some(&0));
```

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

### StartDeployment

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html

Starts the container for the target deployment. Returns an Update response.

```APIDOC
## StartDeployment

### Description
Starts the container for the target deployment. Returns an Update response.

### Response
Update

```

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

### as_number: Get Number reference from JSON value

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.JsonValue.html

Returns Some(&Number) if the Value is a Number, otherwise None. The example shows conversions for integer, float, negative, and string values.

```rust
let v = json!({ "a": 1, "b": 2.2, "c": -3, "d": "4" });

assert_eq!(v["a"].as_number(), Some(&Number::from(1u64)));
assert_eq!(v["b"].as_number(), Some(&Number::from_f64(2.2).unwrap()));
assert_eq!(v["c"].as_number(), Some(&Number::from(-3i64)));

// The string `"4"` is not a number.
assert_eq!(v["d"].as_number(), None);
```

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

### as_str: Get string slice from JSON value

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.JsonValue.html

Returns Some(&str) if the Value is a String, otherwise None. The example also shows how JSON strings are printed with quotes while Rust strings are not.

```rust
let v = json!({ "a": "some string", "b": false });

assert_eq!(v["a"].as_str(), Some("some string"));

// The boolean `false` is not a string.
assert_eq!(v["b"].as_str(), None);

// JSON values are printed in JSON representation, so strings are in quotes.
//
//    The value is: "some string"
println!("The value is: {}", v["a"]);

// Rust strings are printed without quotes.
//
//    The value is: some string
println!("The value is: {}", v["a"].as_str().unwrap());
```

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

### StartDeployment

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=

Starts the container for the target deployment.

```APIDOC
## StartDeployment

### Description
Starts the container for the target deployment.

### Method
POST

### Endpoint
/execute/start-deployment

### Parameters
#### Request Body
- **deployment_id** (string) - Required - The ID of the deployment.

### Request Example
{
  "deployment_id": "deployment-789"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

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

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

### String::split_off example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html

Splits the string at a byte index. The example splits "Hello, World!" at index 7, resulting in "Hello, " and "World!".

```rust
let mut hello = String::from("Hello, World!");
let world = hello.split_off(7);
assert_eq!(hello, "Hello, ");
assert_eq!(world, "World!");
```

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

### as_array_mut: Get mutable array reference from JSON value

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.JsonValue.html

Returns Some(&mut Vec<Value>) if the Value is an array, otherwise None. The example clears the array in place and verifies the result.

```rust
let mut v = json!({ "a": ["an", "array"] });

v["a"].as_array_mut().unwrap().clear();
assert_eq!(v, json!({ "a": [] }));
```

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

### StartDeployment

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Starts the container for the target deployment.

```APIDOC
## StartDeployment

### Description
Starts the container for the target deployment.

### Method
POST

### Endpoint
/execute/start-deployment

### Parameters
#### Request Body
- **deployment_id** (string) - Required - The ID of the deployment.

### Request Example
{
  "deployment_id": "deployment-123"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

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

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

### StartDeployment

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=u32+-%3E+bool

Starts the container for the target deployment.

```APIDOC
## StartDeployment

### Description
Starts the container for the target deployment.

### Method
POST

### Endpoint
/execute/start-deployment

### Parameters
#### Request Body
- **deployment_id** (string) - Required - The ID of the deployment.

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.

#### Response Example
{
  "status": "success"
}
```

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

### as_array: Get array reference from JSON value

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.JsonValue.html

Returns Some(&Vec<Value>) if the Value is an array, otherwise None. The example shows accessing an array element and checking a non-array object.

```rust
let v = json!({ "a": ["an", "array"], "b": { "an": "object" } });

// The length of `["an", "array"]` is 2 elements.
assert_eq!(v["a"].as_array().unwrap().len(), 2);

// The object `{"an": "object"}` is not an array.
assert_eq!(v["b"].as_array(), None);
```

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

### Initialize Vec elements via as_non_null pointer writes

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/type.BatchExecutionResponse.html?search=

Nightly-only example using vec_as_non_null feature. Allocates a Vec with capacity 4, uses as_non_null to get a NonNull pointer, writes elements with .add().write(), sets length, and asserts the slice.

```rust
#![feature(vec_as_non_null)]

// Allocate vector big enough for 4 elements.
let size = 4;
let mut x: Vec<i32> = Vec::with_capacity(size);
let x_ptr = x.as_non_null();

// Initialize elements via raw pointer writes, then set length.
unsafe {
    for i in 0..size {
        x_ptr.add(i).write(i as i32);
    }
    x.set_len(size);
}
assert_eq!(&*x, &[0, 1, 2, 3]);
```

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

### ListOnboardingKeys

Source: https://docs.rs/komodo_client/latest/komodo_client/api/read/index.html?search=

Admin only. Gets list of onboarding keys. Response: ListOnboardingKeysResponse.

```APIDOC
## ListOnboardingKeys

### Description
**Admin only.** Gets list of onboarding keys.

### Response
ListOnboardingKeysResponse
```

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

### ListOnboardingKeys

Source: https://docs.rs/komodo_client/latest/komodo_client/api/read/index.html?search=std%3A%3Avec

Admin only. Gets list of onboarding keys. Response: ListOnboardingKeysResponse.

```APIDOC
## ListOnboardingKeys

### Description
**Admin only.** Gets list of onboarding keys.

### Response
- **ListOnboardingKeysResponse** - The response containing the list of onboarding keys.
```

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

### CreateOnboardingKey

Source: https://docs.rs/komodo_client/latest/komodo_client/api/write/index.html

Admin only. Creates a Server onboarding key. Returns CreateOnboardingKeyResponse.

```APIDOC
## CreateOnboardingKey

### Description
**Admin only.** Create a Server onboarding key. Response: CreateOnboardingKeyResponse.

### Method
POST

### Endpoint
/api/write/create_onboarding_key

### Parameters
#### Request Body
- **name** (string) - Required - The name of the key.

### Response
#### Success Response (200)
- **CreateOnboardingKeyResponse** (object) - Contains the onboarding key.

#### Response Example
{
  "key": "string"
}
```

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

### new

Source: https://docs.rs/komodo_client/latest/komodo_client/struct.KomodoClient.html?search=

Initializes a new KomodoClient with address, key, and secret.

```APIDOC
## new

### Description
Initializes KomodoClient, including a health check.

### Method
fn new

### Signature
pub fn new(address: impl Into<String>, key: impl Into<String>, secret: impl Into<String>) -> KomodoClient

### Parameters
- **address** (impl Into<String>) - Required - The address of the Komodo Core.
- **key** (impl Into<String>) - Required - The API key.
- **secret** (impl Into<String>) - Required - The API secret.

### Returns
- **KomodoClient** - The initialized client.
```

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

### Vec<T> - Example Usage

Source: https://docs.rs/komodo_client/latest/komodo_client/api/read/type.ListFullBuildsResponse.html?search=std%3A%3Avec

An example demonstrating how to use Vec<T> with iterators and memory management.

```APIDOC
## Vec<T> - Example Usage

### Description
An example showing how to create a Vec<T> from an iterator, filter elements, and manage memory capacity.

### Code Example
```rust
for i in 0..10 {
    let big_temporary: Vec<u16> = (0..1024).collect();
    // discard most items
    let mut result: Vec<_> = big_temporary.into_iter().filter(|i| i % 100 == 0).collect();
    // without this a lot of unused capacity might be moved into the global
    result.shrink_to_fit();
    LONG_LIVED.lock().unwrap().push(result);
}
```
```

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

### CreateServer

Source: https://docs.rs/komodo_client/latest/komodo_client/api/write/index.html

Creates a server. Returns Server.

```APIDOC
## CreateServer

### Description
Create a server. Response: Server.

### Method
POST

### Endpoint
/api/write/create_server

### Parameters
#### Request Body
- **name** (string) - Required - The name of the server.
- **config** (object) - Required - The server configuration.

### Response
#### Success Response (200)
- **Server** (object) - The created server.

#### Response Example
{
  "id": "string",
  "name": "string"
}
```

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

### StartContainer

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=

Starts the container on the target server.

```APIDOC
## StartContainer

### Description
Starts the container on the target server.

### Method
POST

### Endpoint
/execute/start-container

### Parameters
#### Request Body
- **server_id** (string) - Required - The ID of the target server.
- **container_id** (string) - Required - The ID or name of the container to start.

### Request Example
{
  "server_id": "server-123",
  "container_id": "container-456"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

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

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

### StartContainer

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Starts the container on the target server.

```APIDOC
## StartContainer

### Description
Starts the container on the target server.

### Method
POST

### Endpoint
/execute/start-container

### Parameters
#### Request Body
- **server_id** (string) - Required - The ID of the target server.
- **container_id** (string) - Required - The ID of the container to start.

### Request Example
{
  "server_id": "server-123",
  "container_id": "container-456"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

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

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

### StartContainer

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=u32+-%3E+bool

Starts the container on the target server.

```APIDOC
## StartContainer

### Description
Starts the container on the target server.

### Method
POST

### Endpoint
/execute/start-container

### Parameters
#### Request Body
- **server_id** (string) - Required - The ID of the target server.
- **container_name** (string) - Required - The name of the container to start.

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.

#### Response Example
{
  "status": "success"
}
```

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

### CreateServer

Source: https://docs.rs/komodo_client/latest/komodo_client/api/write/index.html?search=u32+-%3E+bool

Create a server. Response: Server.

```APIDOC
## CreateServer

### Description
Create a server. Response: Server.

### Method
POST

### Endpoint
/api/write/create_server

### Parameters
#### Request Body
- **name** (string) - Required - The name of the server.
- **config** (object) - Required - The configuration of the server.

### Response
#### Success Response (200)
- **Server** (object) - The created server.

#### Response Example
{
  "id": "string",
  "name": "string",
  "config": {}
}
```

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

### StartContainer

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=std%3A%3Avec

Starts the container on the target server. Returns an Update response.

```APIDOC
## StartContainer

### Description
Starts the container on the target server. Returns an Update response.

### Method
POST

### Endpoint
/StartContainer

### Parameters
#### Path Parameters
- **container_id** (string) - Required - The ID of the container to start.

### Request Example
```json
{
  "container_id": "container-123"
}
```

### Response
#### Success Response (200)
- **status** (string) - The result of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### StartContainer

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html

Starts the container on the target server. Returns an Update response.

```APIDOC
## StartContainer

### Description
Starts the container on the target server. Returns an Update response.

### Response
Update

```

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

### String::new Example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html

Creates a new empty String.

```rust
let s = String::new();
```

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

### Vec<T> - Usage Example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/read/type.ListImageHistoryResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

An example demonstrating how to use Vec<T> with filtering and shrinking capacity to manage memory.

```APIDOC
## Vec<T> - Usage Example

### Description
An example showing how to create a Vec, filter it, and shrink its capacity to reduce memory usage.

### Example
```rust
for i in 0..10 {
    let big_temporary: Vec<u16> = (0..1024).collect();
    // discard most items
    let mut result: Vec<_> = big_temporary.into_iter().filter(|i| i % 100 == 0).collect();
    // without this a lot of unused capacity might be moved into the global
    result.shrink_to_fit();
    LONG_LIVED.lock().unwrap().push(result);
}
```
```

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

### new

Source: https://docs.rs/komodo_client/latest/komodo_client/struct.KomodoClient.html

Initializes a new KomodoClient with the given address, key, and secret, including a health check.

```APIDOC
## new

### Description
Initializes KomodoClient, including a health check.

### Method
Constructor

### Signature
```rust
pub fn new(
    address: impl Into<String>,
    key: impl Into<String>,
    secret: impl Into<String>,
) -> KomodoClient
```

### Parameters
- **address** (impl Into<String>) - Required - The address of the Komodo Core.
- **key** (impl Into<String>) - Required - The API key.
- **secret** (impl Into<String>) - Required - The API secret.

### Returns
- **KomodoClient** - The initialized client.
```

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

### dedup example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/type.BatchExecutionResponse.html?search=

Removes consecutive repeated elements. The example shows dedup on a vector with a non-consecutive duplicate.

```rust
let mut vec = vec![1, 2, 2, 3, 2];

vec.dedup();

assert_eq!(vec, [1, 2, 3, 2]);
```

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

### StartDeployment

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/struct.StartDeployment.html?search=

Documentation for the StartDeployment execute request struct.

```APIDOC
## StartDeployment

### Description
Starts the container for the target deployment. Runs `docker start ${container_name}`.

### Request Body
- **deployment** (String) - Required - Name or id of the deployment.

### Response
- **Update** - The response type is `Update`.

```

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

### try_shrink_to_fit example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/type.BatchExecutionResponse.html?search=

Nightly-only example of fallible shrink_to_fit. Uses the vec_fallible_shrink feature and expects the shrink to succeed.

```rust
#![feature(vec_fallible_shrink)]

let mut vec = Vec::with_capacity(10);
vec.extend([1, 2, 3]);
assert!(vec.capacity() >= 10);
vec.try_shrink_to_fit().expect("why is the test harness failing to shrink to 12 bytes");
assert!(vec.capacity() >= 3);
```

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

### English schedule example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/action/struct.ActionConfig.html

Example of an English expression for the schedule field, which is converted to CRON using the english-to-cron parser.

```text
at midnight on the 1st and 15th of the month
```

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

### Vec<T> usage example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/write/type.BatchCheckDeploymentForUpdateResponse.html?search=

Example demonstrating how to create a Vec<T>, filter elements, and store results in a global variable.

```APIDOC
## Vec<T> usage example

### Description
Example demonstrating how to create a Vec<T>, filter elements, and store results in a global variable.

### Example
```rust
for i in 0..10 {
    let big_temporary: Vec<u16> = (0..1024).collect();
    // discard most items
    let mut result: Vec<_> = big_temporary.into_iter().filter(|i| i % 100 == 0).collect();
    // without this a lot of unused capacity might be moved into the global
    result.shrink_to_fit();
    LONG_LIVED.lock().unwrap().push(result);
}
```
```

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

### String::is_empty example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html

Checks if the string has zero length. The example shows that a new String is empty, and after pushing a character it is not.

```rust
let mut v = String::new();
assert!(v.is_empty());

v.push('a');
assert!(!v.is_empty());
```

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

### Initialization and Utility Methods

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

Initialization and utility methods for the KomodoClient.

```APIDOC
## new

### Description
Initializes KomodoClient, including a health check.

### Method
fn

### Signature
```rust
pub fn new(
    address: impl Into<String>,
    key: impl Into<String>,
    secret: impl Into<String>,
) -> KomodoClient
```

### Parameters
- **address** (`impl Into<String>`) - Required - The address of the Komodo Core.
- **key** (`impl Into<String>`) - Required - The API key.
- **secret** (`impl Into<String>`) - Required - The API secret.

### Returns
- `KomodoClient` - A new KomodoClient instance.
```

```APIDOC
## new_from_env

### Description
Initializes KomodoClient from environment variables (KomodoEnv).

### Method
fn

### Signature
```rust
pub fn new_from_env() -> Result<KomodoClient>
```

### Returns
- `Result<KomodoClient>` - A new KomodoClient instance or an error.
```

```APIDOC
## with_healthcheck

### Description
Adds a healthcheck in the initialization pipeline.

### Method
async fn

### Signature
```rust
pub async fn with_healthcheck(self) -> Result<Self>
```

### Returns
- `Result<Self>` - The client with healthcheck performed.

### Example
```rust
let komodo = KomodoClient::new_from_env()?
  .with_healthcheck().await?;
```
```

```APIDOC
## core_version

### Description
Gets the Core version.

### Method
async fn

### Signature
```rust
pub async fn core_version(&self) -> Result<String>
```

### Returns
- `Result<String>` - The Core version string.
```

```APIDOC
## health_check

### Description
Sends a health check.

### Method
async fn

### Signature
```rust
pub async fn health_check(&self) -> Result<()>
```

### Returns
- `Result<()>` - Ok if the health check succeeds.
```

```APIDOC
## set_reqwest

### Description
Uses a custom reqwest client.

### Method
fn

### Signature
```rust
pub fn set_reqwest(self, reqwest: Client) -> Self
```

### Parameters
- **reqwest** (`Client`) - Required - The custom reqwest client.

### Returns
- `Self` - The client with the custom reqwest client set.
```

```APIDOC
## poll_update_until_complete

### Description
Polls an Update (returned by the `execute` calls) until the UpdateStatus is `Complete`, and then returns it.

### Method
async fn

### Signature
```rust
pub async fn poll_update_until_complete(
    &self,
    update_id: impl Into<String>,
) -> Result<Update>
```

### Parameters
- **update_id** (`impl Into<String>`) - Required - The ID of the update to poll.

### Returns
- `Result<Update>` - The completed update.
```

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

### as_non_null: Aliasing guarantee example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/docker/type.GenericResources.html?search=

Nightly-only example demonstrating that multiple calls to as_non_null do not invalidate each other. Requires the vec_as_non_null feature.

```rust
#![feature(vec_as_non_null)]

unsafe {
    let mut v = vec![0];
    let ptr1 = v.as_non_null();
    ptr1.write(1);
    let ptr2 = v.as_non_null();
    ptr2.write(2);
    // Notably, the write to `ptr2` did *not* invalidate `ptr1`:
    ptr1.write(3);
}
```

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

### try_shrink_to example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/type.BatchExecutionResponse.html?search=

Nightly-only example of fallible shrink_to with a lower bound. Uses the vec_fallible_shrink feature and expects the shrink to succeed.

```rust
#![feature(vec_fallible_shrink)]

let mut vec = Vec::with_capacity(10);
vec.extend([1, 2, 3]);
assert!(vec.capacity() >= 10);
vec.try_shrink_to(4).expect("why is the test harness failing to shrink to 12 bytes");
assert!(vec.capacity() >= 4);
vec.try_shrink_to(0).expect("this is a no-op and thus the allocator isn't involved.");
assert!(vec.capacity() >= 3);
```

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

### into_boxed_slice example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/type.BatchExecutionResponse.html

Converts the vector into a boxed slice, discarding excess capacity. The first example shows basic conversion.

```rust
let v = vec![1, 2, 3];

let slice = v.into_boxed_slice();
```

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

### remove example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html

Demonstrates removing a character at a byte position using remove. The example removes characters from a string and asserts the results.

```rust
let mut s = String::from("abç");

assert_eq!(s.remove(0), 'a');
assert_eq!(s.remove(1), 'ç');
assert_eq!(s.remove(0), 'b');

```

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

### CreateBuild

Source: https://docs.rs/komodo_client/latest/komodo_client/api/write/index.html?search=u32+-%3E+bool

Create a build. Response: Build.

```APIDOC
## CreateBuild

### Description
Create a build. Response: Build.

### Method
POST

### Endpoint
/api/write/create_build

### Parameters
#### Request Body
- **name** (string) - Required - The name of the build.
- **config** (object) - Required - The configuration of the build.

### Response
#### Success Response (200)
- **Build** (object) - The created build.

#### Response Example
{
  "id": "string",
  "name": "string",
  "config": {}
}
```

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

### StartAllContainers

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html

Starts all containers on the target server. Returns an Update response.

```APIDOC
## StartAllContainers

### Description
Starts all containers on the target server. Returns an Update response.

### Response
Update

```

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

### splice example

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/type.BatchExecutionResponse.html?search=

Replaces a range with an iterator and yields removed items. The example replaces indices 1..3 with [7,8,9].

```rust
let mut v = vec![1, 2, 3, 4];
let new = [7, 8, 9];
let u: Vec<_> = v.splice(1..3, new).collect();
assert_eq!(v, [1, 7, 8, 9, 4]);
assert_eq!(u, [2, 3]);
```

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

### Example parsed command output

Source: https://docs.rs/komodo_client/latest/komodo_client/parsers/fn.parse_multiline_command.html?search=u32+-%3E+bool

Expected output of parse_multiline_command for the example input. Commands are chained with '&&', comments are removed, and escaped newlines are collapsed.

```shell
sh ./shell1.sh && sh ./shell2.sh && {long curl command} && echo done
```

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

### StartAllContainers

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=std%3A%3Avec

Starts all containers on the target server. Returns an Update response.

```APIDOC
## StartAllContainers

### Description
Starts all containers on the target server. Returns an Update response.

### Method
POST

### Endpoint
/StartAllContainers

### Parameters
#### Path Parameters
- **server_id** (string) - Required - The ID of the target server.

### Request Example
```json
{
  "server_id": "server-123"
}
```

### Response
#### Success Response (200)
- **status** (string) - The result of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### Return value for parse_key_value_list example

Source: https://docs.rs/komodo_client/latest/komodo_client/parsers/fn.parse_key_value_list.html?search=std%3A%3Avec

Expected return value for the example input. Note that wrapping quotes are preserved on values, as stated in the documentation.

```rust
[
  ("KEY_1", "value_1"),
  ("KEY_2", "\"value_2\""),
  ("KEY_3", "value_3"),
  ("KEY_4", "'value_4'"),
  ("KEY_5", "value_5"),
  ("KEY_6", "'value_6'"),
]
```

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

### reserve example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html?search=std%3A%3Avec

Reserves capacity for at least additional bytes. The second example shows that reserve may not increase capacity if already sufficient.

```rust
let mut s = String::new();

s.reserve(10);

assert!(s.capacity() >= 10);
```

```rust
let mut s = String::with_capacity(10);
s.push('a');
s.push('b');

// s now has a length of 2 and a capacity of at least 10
let capacity = s.capacity();
assert_eq!(2, s.len());
assert!(capacity >= 10);

// Since we already have at least an extra 8 capacity, calling this...
s.reserve(8);

// ... doesn't actually increase.
assert_eq!(capacity, s.capacity());
```

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

### StartAllContainers

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=

Starts all containers on the target server.

```APIDOC
## StartAllContainers

### Description
Starts all containers on the target server.

### Method
POST

### Endpoint
/execute/start-all-containers

### Parameters
#### Request Body
- **server_id** (string) - Required - The ID of the target server.

### Request Example
{
  "server_id": "server-123"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

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

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

### truncate example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/type.MongoId.html

Demonstrates truncating a String to a specified length. The example truncates "hello" to 2 characters and asserts the result.

```rust
let mut s = String::from("hello");

s.truncate(2);

assert_eq!("he", s);

```

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

### StartAllContainers

Source: https://docs.rs/komodo_client/latest/komodo_client/api/execute/index.html?search=u32+-%3E+bool

Starts all containers on the target server.

```APIDOC
## StartAllContainers

### Description
Starts all containers on the target server.

### Method
POST

### Endpoint
/execute/start-all-containers

### Parameters
#### Request Body
- **server_id** (string) - Required - The ID of the target server.

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.

#### Response Example
{
  "status": "success"
}
```

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

### CRON schedule example

Source: https://docs.rs/komodo_client/latest/komodo_client/entities/action/struct.ActionConfig.html

Example of a regular CRON expression for the schedule field. The format is (second, minute, hour, day, month, day-of-week).

```text
0 0 0 1,15 * ?
```
Tokens:
Raw