ncm-api-rs

https://docs.rs/ncm-api-rs/latest/ncm_api_rs/
Admin
Netease Cloud Music API Rust SDK - a Rust native implementation supporting weapi, eapi, and linuxapi...
Tokens:49,244
Snippets:499
Trust Score:9.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### Safely get Ok value (nightly)

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Use `into_ok()` to get the contained Ok value without panicking. This method is known to never panic and can serve as a compile-time safeguard.

```rust
fn only_good_news() -> Result<String, !> {
    Ok("this is fine".into())
}

let s: String = only_good_news().into_ok();
println!("{s}");
```

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

### Getting a Reference to the Ok Value

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

The `as_ref()` method converts a `&Result<T, E>` into a `Result<&T, &E>`. This allows inspecting the contained value without consuming the `Result`.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.as_ref(), Ok(&2));

let x: Result<u32, &str> = Err("Error");
assert_eq!(x.as_ref(), Err(&"Error"));
```

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

### Get i64 Query Parameter

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/api/struct.Query.html

Retrieves an i64 parameter value, parsing it from a string. Returns a default i64 value if parsing fails or the parameter is not found. This replaces the common pattern of `query.get_or("limit", "30").parse::<i64>().unwrap_or(30)`.

```rust
pub fn get_i64(&self, key: &str, default: i64) -> i64
```

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

### Safely get Err value (nightly)

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Use `into_err()` to get the contained Err value without panicking. This method is known to never panic and can serve as a compile-time safeguard.

```rust
fn only_bad_news() -> Result<!, String> {
    Err("Oops, it failed".into())
}

let error: String = only_bad_news().into_err();
println!("{error}");
```

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

### new

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Creates a new API client instance.

```APIDOC
## new

### Description
Creates a new API client instance.

### Method
Constructor

### Parameters
#### Query Parameters
- **cookie** (string) - Optional - The cookie string for authentication.
```

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

### Query Policy - OR

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/api/struct.Query.html

Creates a new policy that returns Action::Follow if either self or other policy returns Action::Follow.

```rust
fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>
```

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

### Get Query Parameter with Default

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/api/struct.Query.html

Retrieves the value of a query parameter, returning a default string if the parameter is not found.

```rust
pub fn get_or(&self, key: &str, default: &str) -> String
```

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

### Query Policy - AND

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/api/struct.Query.html

Creates a new policy that requires both self and other policies to return Action::Follow.

```rust
fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>
```

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

### Get Query Parameter Value

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/api/struct.Query.html

Retrieves the value of a specific query parameter by its key. Returns None if the key does not exist.

```rust
pub fn get(&self, key: &str) -> Option<&str>
```

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

### program_recommend

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Fetches recommended programs. Corresponds to the /program/recommend endpoint.

```APIDOC
## program_recommend

### Description
Fetches recommended programs.

### Method
POST

### Endpoint
/program/recommend

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching recommended programs.
```

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

### Unwrap Ok value

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Use `unwrap()` to get the contained Ok value. Panics if the value is an Err, with a panic message provided by the Err's value.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.unwrap(), 2);
```

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

### activate_init_profile

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Initializes a user profile with a name. Corresponds to the /activate/init/profile endpoint.

```APIDOC
## activate_init_profile

### Description
Initializes a user profile with a name.

### Method
POST

### Endpoint
/activate/init/profile

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for initializing the profile.
```

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

### recommend_resource

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Fetches recommended resources (requires login). Corresponds to the /recommend/resource endpoint.

```APIDOC
## recommend_resource

### Description
Fetches recommended resources. Requires user login.

### Method
POST

### Endpoint
/recommend/resource

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching recommended resources.
```

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

### Unwrap Err value

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Use `unwrap_err()` to get the contained Err value. Panics if the value is an Ok, with a custom panic message provided by the Ok's value.

```rust
let x: Result<u32, &str> = Ok(2);
x.unwrap_err(); // panics with `2`
```

```rust
let x: Result<u32, &str> = Err("emergency failure");
assert_eq!(x.unwrap_err(), "emergency failure");
```

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

### listentogether_room_create

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Creates a new room for a 'Listen Together' session. Corresponds to the /listentogether/room/create endpoint.

```APIDOC
## listentogether_room_create

### Description
Creates a new room for a 'Listen Together' session.

### Method
POST

### Endpoint
/listentogether/room/create

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for the request.
```

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

### Unwrap or return default value

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Use `unwrap_or_default()` to get the contained Ok value or the default value for the type if it's an Err. This is useful for providing sensible fallbacks.

```rust
let good_year_from_input = "1909";
let bad_year_from_input = "190blarg";
let good_year = good_year_from_input.parse().unwrap_or_default();
let bad_year = bad_year_from_input.parse().unwrap_or_default();

assert_eq!(1909, good_year);
assert_eq!(0, bad_year);
```

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

### login_qr_create

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Generates a QR code for login. Corresponds to the /login/qr/create endpoint.

```APIDOC
## login_qr_create

### Description
Generates a QR code for login.

### Method
POST

### Endpoint
/login/qr/create

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for creating a QR code.
```

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

### Getting a Mutable Reference to the Value

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

The `as_mut()` method converts a `&mut Result<T, E>` into a `Result<&mut T, &mut E>`. This allows modifying the contained value in place.

```rust
fn mutate(r: &mut Result<i32, i32>) {
    match r.as_mut() {
        Ok(v) => *v = 42,
        Err(e) => *e = 0,
    }
}

let mut x: Result<i32, i32> = Ok(2);
mutate(&mut x);
assert_eq!(x.unwrap(), 42);

let mut x: Result<i32, i32> = Err(13);
mutate(&mut x);
assert_eq!(x.unwrap_err(), 0);
```

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

### create_client

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/all.html

Creates a new API client instance. This is the entry point for making requests to the NCM API.

```APIDOC
## create_client

### Description
Creates a new API client instance. This function initializes the necessary components for making authenticated requests to the NCM API.

### Function Signature
`create_client()`

### Returns
- `request::ApiClient` - An initialized API client object.
```

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

### Expect Err value with custom panic message

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Use `expect_err()` to get the contained Err value. Panics if the value is an Ok, with a panic message including the passed message and the content of the Ok.

```rust
let x: Result<u32, &str> = Ok(10);
x.expect_err("Testing expect_err"); // panics with `Testing expect_err: 10`
```

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

### with_proxy

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Creates an API client instance with a specified proxy.

```APIDOC
## with_proxy

### Description
Creates an API client instance with a specified proxy.

### Method
Constructor

### Parameters
#### Query Parameters
- **cookie** (string) - Optional - The cookie string for authentication.
- **proxy_url** (string) - Required - The URL of the proxy server.
```

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

### Initialize Query Struct

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/api/struct.Query.html

Creates a new instance of the Query struct.

```rust
pub fn new() -> Self
```

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

### util::config::get_os_config

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/all.html

Retrieves the operating system configuration. This function provides details about the current OS environment.

```APIDOC
## util::config::get_os_config

### Description
Fetches and returns the operating system configuration details. This information can be used to tailor API requests.

### Function Signature
`util::config::get_os_config() -> OsConfig

### Returns
- `OsConfig` - An `OsConfig` struct containing OS-specific settings.
```

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

### Get Boolean Query Parameter

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/api/struct.Query.html

Retrieves a boolean parameter value, accepting 'true', 'false', '1', or '0' as string representations. Returns a default boolean value if the parameter is not found or cannot be interpreted. This replaces patterns like `query.get_or("like", "true") == "true"`.

```rust
pub fn get_bool(&self, key: &str, default: bool) -> bool
```

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

### into_ok

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Returns the contained Ok value, but never panics. This is an experimental API.

```APIDOC
## into_ok

### Description
Returns the contained `Ok` value, but never panics. Unlike `unwrap`, this method is known to never panic on the result types it is implemented for. Therefore, it can be used instead of `unwrap` as a maintainability safeguard that will fail to compile if the error type of the `Result` is later changed to an error that can actually occur.

### Method
`into_ok()`

### Parameters
None

### Request Example
```rust
fn only_good_news() -> Result<String, !> {
    Ok("this is fine".into())
}

let s: String = only_good_news().into_ok();
println!("{s}");
```

### Response
#### Success Response
- `T`: The contained `Ok` value.
```

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

### Handling File Metadata with Result

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Shows how to use Result methods to handle potential errors when accessing file metadata. It checks for successful retrieval of metadata and specifically checks for 'NotFound' errors.

```rust
use std::{io::ErrorKind, path::Path};

// Note: on Windows "/" maps to "C:\\"
let root_modified_time = Path::new("/").metadata().and_then(|md| md.modified());
assert!(root_modified_time.is_ok());

let should_fail = Path::new("/bad/path").metadata().and_then(|md| md.modified());
assert!(should_fail.is_err());
assert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
```

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

### setting

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Allows users to adjust their settings. Corresponds to the /setting endpoint.

```APIDOC
## POST /setting

### Description
Allows users to adjust their settings.

### Method
POST

### Endpoint
/setting

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for user settings.
```

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

### listentogether_sync_list_command

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Sends a command to update the playback list in a 'Listen Together' session. Corresponds to the /listentogether/sync/list/command endpoint.

```APIDOC
## listentogether_sync_list_command

### Description
Sends a command to update the playback list in a 'Listen Together' session.

### Method
POST

### Endpoint
/listentogether/sync/list/command

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for the request.
```

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

### listentogether_accept

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Accepts an invitation to a 'Listen Together' session. Corresponds to the /listentogether/accept endpoint.

```APIDOC
## listentogether_accept

### Description
Accepts an invitation to a 'Listen Together' session.

### Method
POST

### Endpoint
/listentogether/accept

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for the request.
```

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

### music_first_listen_info

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves information for the first listen experience, often referred to as 'Memory Coordinates'. Corresponds to the /music/first/listen/info endpoint.

```APIDOC
## music_first_listen_info

### Description
Retrieves information for the first listen experience, often referred to as 'Memory Coordinates'.

### Method
GET

### Endpoint
/music/first/listen/info

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for the request.
```

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

### OsConfig Struct Definition

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/util/config/struct.OsConfig.html

Defines the structure for OS configuration, holding static string slices for OS type, app version, OS version, and channel.

```rust
pub struct OsConfig {
    pub os: &'static str,
    pub appver: &'static str,
    pub osver: &'static str,
    pub channel: &'static str,
}
```

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

### ok

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Converts `Result<T, E>` into `Option<T>`, consuming the `Result`.

```APIDOC
## ok

### Description
Converts `Result<T, E>` into `Option<T>`, consuming the `Result`. If the `Result` is `Ok`, it returns `Some(T)`. If the `Result` is `Err`, it returns `None`.

### Method
`ok()`

### Parameters
None

### Response
- `Some(T)` if the `Result` was `Ok(T)`.
- `None` if the `Result` was `Err(E)`.

### Example
```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.ok(), Some(2));

let x: Result<u32, &str> = Err("Nothing here");
assert_eq!(x.ok(), None);
```
```

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

### util::config::choose_user_agent

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/all.html

Chooses an appropriate user agent string based on the operating system configuration.

```APIDOC
## util::config::choose_user_agent

### Description
Selects and returns a user agent string suitable for the current operating system. This helps in mimicking real client requests.

### Function Signature
`util::config::choose_user_agent() -> String

### Returns
- `String` - A user agent string.
```

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

### recommend_songs

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Fetches daily recommended songs (requires login). Corresponds to the /recommend/songs endpoint.

```APIDOC
## recommend_songs

### Description
Fetches daily recommended songs. Requires user login.

### Method
POST

### Endpoint
/recommend/songs

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching daily recommended songs.
```

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

### user_playlist_create

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves the list of playlists created by the user. Corresponds to the /user/playlist/create endpoint.

```APIDOC
## POST /user/playlist/create

### Description
Retrieves the list of playlists created by the user.

### Method
POST

### Endpoint
/user/playlist/create

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching user's created playlists.
```

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

### CloneToUninit Trait Implementation (Nightly)

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiResponse.html

Nightly-only experimental API for performing copy-assignment to uninitialized memory.

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

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

### verify_get_qr

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves a verification QR code. Corresponds to the /verify/getQr endpoint.

```APIDOC
## POST /verify/getQr

### Description
Retrieves a verification QR code.

### Method
POST

### Endpoint
/verify/getQr

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for getting the QR code.
```

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

### Result Implementations

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Provides documentation for various methods implemented for the Result type, enabling common operations like copying, cloning, transposing, flattening, and checking status.

```APIDOC
## Result Implementations

This section details the various methods available for the `Result` type, offering functionalities to manipulate and inspect success or error states.

### `impl<T, E> Result<&T, E>`

#### `pub const fn copied(self) -> Result<T, E>` where `T: Copy`

**Description**: Maps a `Result<&T, E>` to a `Result<T, E>` by copying the contents of the `Ok` part. This is useful when you have a reference to a value that implements the `Copy` trait and want to obtain an owned value.

**Examples**:
```rust
let val = 12;
let x: Result<&i32, i32> = Ok(&val);
assert_eq!(x, Ok(&12));
let copied = x.copied();
assert_eq!(copied, Ok(12));
```

#### `pub fn cloned(self) -> Result<T, E>` where `T: Clone`

**Description**: Maps a `Result<&T, E>` to a `Result<T, E>` by cloning the contents of the `Ok` part. This is useful when you have a reference to a value that implements the `Clone` trait and want to obtain an owned value.

**Examples**:
```rust
let val = 12;
let x: Result<&i32, i32> = Ok(&val);
assert_eq!(x, Ok(&12));
let cloned = x.cloned();
assert_eq!(cloned, Ok(12));
```

### `impl<T, E> Result<&mut T, E>`

#### `pub const fn copied(self) -> Result<T, E>` where `T: Copy`

**Description**: Maps a `Result<&mut T, E>` to a `Result<T, E>` by copying the contents of the `Ok` part. This is useful when you have a mutable reference to a value that implements the `Copy` trait and want to obtain an owned value.

**Examples**:
```rust
let mut val = 12;
let x: Result<&mut i32, i32> = Ok(&mut val);
assert_eq!(x, Ok(&mut 12));
let copied = x.copied();
assert_eq!(copied, Ok(12));
```

#### `pub fn cloned(self) -> Result<T, E>` where `T: Clone`

**Description**: Maps a `Result<&mut T, E>` to a `Result<T, E>` by cloning the contents of the `Ok` part. This is useful when you have a mutable reference to a value that implements the `Clone` trait and want to obtain an owned value.

**Examples**:
```rust
let mut val = 12;
let x: Result<&mut i32, i32> = Ok(&mut val);
assert_eq!(x, Ok(&mut 12));
let cloned = x.cloned();
assert_eq!(cloned, Ok(12));
```

### `impl<T, E> Result<Option<T>, E>`

#### `pub const fn transpose(self) -> Option<Result<T, E>>`

**Description**: Transposes a `Result` of an `Option` into an `Option` of a `Result`. `Ok(None)` will be mapped to `None`. `Ok(Some(_))` and `Err(_)` will be mapped to `Some(Ok(_))` and `Some(Err(_))` respectively.

**Examples**:
```rust
#[derive(Debug, Eq, PartialEq)]
struct SomeErr;

let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
assert_eq!(x.transpose(), y);
```

### `impl<T, E> Result<Result<T, E>, E>`

#### `pub const fn flatten(self) -> Result<T, E>`

**Description**: Converts from `Result<Result<T, E>, E>` to `Result<T, E>`. This method effectively removes one level of nesting when dealing with nested `Result` types.

**Examples**:
```rust
let x: Result<Result<&'static str, u32>, u32> = Ok(Ok("hello"));
assert_eq!(Ok("hello"), x.flatten());

let x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));
assert_eq!(Err(6), x.flatten());

let x: Result<Result<&'static str, u32>, u32> = Err(6);
assert_eq!(Err(6), x.flatten());

// Flattening only removes one level of nesting at a time:
let x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok("hello")));
assert_eq!(Ok(Ok("hello")), x.flatten());
assert_eq!(Ok("hello"), x.flatten().flatten());
```

### `impl<T, E> Result<T, E>`

#### `pub const fn is_ok(&self) -> bool`

**Description**: Returns `true` if the result is `Ok`.

**Examples**:
```rust
let x: Result<i32, &str> = Ok(-3);
assert_eq!(x.is_ok(), true);

let x: Result<i32, &str> = Err("Some error message");
assert_eq!(x.is_ok(), false);
```

#### `pub fn is_ok_and<F>(self, f: F) -> bool` where `F: FnOnce(T) -> bool`

**Description**: Returns `true` if the result is `Ok` and the value inside of it matches a predicate. The predicate `f` is a closure that takes the contained value and returns a boolean.

**Examples**:
```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.is_ok_and(|x| x > 1), true);

let x: Result<u32, &str> = Ok(0);
assert_eq!(x.is_ok_and(|x| x > 1), false);

let x: Result<u32, &str> = Err("hey");
assert_eq!(x.is_ok_and(|x| x > 1), false);

let x: Result<String, &str> = Ok("ownership".to_string());
assert_eq!(x.as_ref().is_ok_and(|x| x.len() > 1), true);
println!("still alive {:?}", x);
```

#### `pub const fn is_err(&self) -> bool`

**Description**: Returns `true` if the result is `Err`.

**Examples**:
```rust
let x: Result<i32, &str> = Ok(-3);
assert_eq!(x.is_err(), false);

let x: Result<i32, &str> = Err("Some error message");
assert_eq!(x.is_err(), true);
```

#### `pub fn is_err_and<F>(self, f: F) -> bool` where `F: FnOnce(E) -> bool`

**Description**: Returns `true` if the result is `Err` and the value inside of it matches a predicate. The predicate `f` is a closure that takes the contained error and returns a boolean.

(No examples provided in source for this method.)
```

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

### style_detail

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves details about a specific musical style. Corresponds to the /style/detail endpoint.

```APIDOC
## style_detail

### Description
Retrieves detailed information about a specific musical style.

### Method
POST

### Endpoint
/style/detail

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for retrieving style details.

### Response
#### Success Response (200)
- **ApiResponse** - The API response containing the details of the specified musical style.
```

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

### user_audio

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves user-created radio programs. Corresponds to the /user/audio endpoint.

```APIDOC
## POST /user/audio

### Description
Retrieves user-created radio programs.

### Method
POST

### Endpoint
/user/audio

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching user's radio programs.
```

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

### style_list

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves a list of available musical styles. Corresponds to the /style/list endpoint.

```APIDOC
## style_list

### Description
Retrieves a list of available musical styles.

### Method
POST

### Endpoint
/style/list

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for retrieving the list of styles.

### Response
#### Success Response (200)
- **ApiResponse** - The API response containing the list of musical styles.
```

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

### Query Methods

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/api/struct.Query.html

Provides methods for creating, setting, and retrieving parameters for API queries.

```APIDOC
## impl Query

### `new()`

Creates a new instance of the Query struct.

### `param(self, key: &str, value: &str) -> Self`

Sets a custom query parameter.

### `cookie(self, cookie: &str) -> Self`

Sets the cookie string for the query.

### `get(key: &str) -> Option<&str>`

Retrieves the value of a query parameter by its key. Returns `None` if the key does not exist.

### `get_or(key: &str, default: &str) -> String`

Retrieves the value of a query parameter by its key. Returns a default value if the key does not exist.

### `get_i64(key: &str, default: i64) -> i64`

Retrieves an i64 parameter value. Parses the string value associated with the key as an i64. If parsing fails or the key does not exist, returns the provided default value. This is a convenient alternative to the `get_or` followed by `parse` and `unwrap_or` pattern.

### `get_bool(key: &str, default: bool) -> bool`

Retrieves a boolean parameter value. It accepts "true", "false", "1", or "0" as string representations of boolean values. If the key does not exist or the value is not recognized, it returns the provided default value. This simplifies boolean checks compared to manually comparing strings.
```

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

### unwrap_or

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Returns the contained `Ok` value or a provided default. Arguments are eagerly evaluated.

```APIDOC
## unwrap_or

### Description
Returns the contained `Ok` value or a provided default. Arguments passed to `unwrap_or` are eagerly evaluated.

### Method
`unwrap_or`

### Parameters
- `default`: The default value to return if `self` is `Err`.

### Examples
```rust
let default = 2;
let x: Result<u32, &str> = Ok(9);
assert_eq!(x.unwrap_or(default), 9);

let x: Result<u32, &str> = Err("error");
assert_eq!(x.unwrap_or(default), default);
```
```

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

### cloud_import

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Imports songs into the cloud. Corresponds to the /cloud/import (import step) endpoint.

```APIDOC
## POST /cloud/import

### Description
Imports songs into the cloud.

### Method
POST

### Endpoint
/cloud/import

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### listentogether_sync_playlist_get

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves the current playback list for a 'Listen Together' session. Corresponds to the /listentogether/sync/playlist/get endpoint.

```APIDOC
## listentogether_sync_playlist_get

### Description
Retrieves the current playback list for a 'Listen Together' session.

### Method
GET

### Endpoint
/listentogether/sync/playlist/get

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for the request.
```

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

### personalized

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Fetches personalized song recommendations. Corresponds to the /personalized endpoint.

```APIDOC
## personalized

### Description
Fetches personalized song recommendations.

### Method
POST

### Endpoint
/personalized

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching personalized recommendations.
```

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

### login

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Logs in a user via email. Corresponds to the /login endpoint. Note: The Node.js version MD5s the password; the Rust version requires `md5_password` or a pre-MD5'd `password`.

```APIDOC
## login

### Description
Logs in a user via email.

### Method
POST

### Endpoint
/login

### Parameters
#### Query Parameters
- **query** (Query) - Required - Login credentials. For Rust, `md5_password` or `password` (pre-MD5'd) should be used.
```

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

### login_qr_key

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Generates a key for QR code login. Corresponds to the /login/qr/key endpoint.

```APIDOC
## login_qr_key

### Description
Generates a key for QR code login.

### Method
POST

### Endpoint
/login/qr/key

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for generating a QR code key.
```

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

### album_songsaleboard

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves the sales board for digital albums and singles. Corresponds to the /album/songsaleboard endpoint.

```APIDOC
## album_songsaleboard

### Description
Retrieves the sales board for digital albums and singles.

### Method
GET

### Endpoint
/album/songsaleboard

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### history_recommend_songs_detail

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves detailed information about historically recommended songs. Corresponds to the /history/recommend/songs/detail endpoint.

```APIDOC
## history_recommend_songs_detail

### Description
Retrieves detailed information about historically recommended songs.

### Method
POST

### Endpoint
/history/recommend/songs/detail

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching historical recommended songs details.
```

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

### event

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves user dynamics. Corresponds to the /event endpoint.

```APIDOC
## event

### Description
Retrieves user dynamics.

### Method
POST

### Endpoint
/event

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for retrieving events.

### Response
#### Success Response (200)
- **ApiResponse** - The API response containing event information.
```

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

### album_privilege

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves the audio quality for album songs. Corresponds to the /album/privilege endpoint.

```APIDOC
## album_privilege

### Description
Retrieves the audio quality for album songs.

### Method
GET

### Endpoint
/album/privilege

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### yunbei_tasks

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Fetches the list of all available Yunbei tasks. Corresponds to the /yunbei/tasks endpoint.

```APIDOC
## POST /yunbei/tasks

### Description
Fetches the list of all available Yunbei tasks.

### Method
POST

### Endpoint
/yunbei/tasks

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### get_os_config Function Signature

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/util/config/fn.get_os_config.html

This snippet shows the function signature for get_os_config. It takes a string slice representing the OS name and returns a static reference to an OsConfig struct.

```rust
pub fn get_os_config(os_name: &str) -> &'static OsConfig
```

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

### personalized_djprogram

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Fetches personalized DJ program recommendations. Corresponds to the /personalized/djprogram endpoint.

```APIDOC
## personalized_djprogram

### Description
Fetches personalized DJ program recommendations.

### Method
POST

### Endpoint
/personalized/djprogram

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching personalized DJ programs.
```

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

### lyric_new

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves new version lyrics, including word-by-word lyrics. Corresponds to the /lyric/new API endpoint.

```APIDOC
## lyric_new

### Description
Retrieves new version lyrics, including word-by-word lyrics.

### Method
POST

### Endpoint
/lyric/new

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for the new lyric request.

### Response
#### Success Response (200)
- **ApiResponse** - The API response containing the new lyrics.
```

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

### listentogether_play_command

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Sends playback status commands for a 'Listen Together' session. Corresponds to the /listentogether/play/command endpoint.

```APIDOC
## listentogether_play_command

### Description
Sends playback status commands for a 'Listen Together' session.

### Method
POST

### Endpoint
/listentogether/play/command

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for the request.
```

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

### get_os_config

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/util/config/fn.get_os_config.html

Retrieves the operating system configuration for a given OS name. This function is part of the utility configuration module.

```APIDOC
## Function get_os_config

### Description
Retrieves the operating system configuration based on the provided OS name.

### Signature
```rust
pub fn get_os_config(os_name: &str) -> &'static OsConfig
```

### Parameters
* **os_name** (`&str`): The name of the operating system for which to retrieve the configuration.
```

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

### album_new

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves all new albums. Corresponds to the /album/new endpoint.

```APIDOC
## album_new

### Description
Retrieves all new albums.

### Method
GET

### Endpoint
/album/new

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### style_preference

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves user's musical style preferences. Corresponds to the /style/preference endpoint.

```APIDOC
## style_preference

### Description
Retrieves the user's musical style preferences.

### Method
POST

### Endpoint
/style/preference

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for retrieving style preferences.

### Response
#### Success Response (200)
- **ApiResponse** - The API response containing the user's style preferences.
```

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

### song_url_v1_302

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves the client song download URL (302 redirect). First attempts download/url/v1, then falls back to player/url/v1, and finally returns a 302 response with a redirectUrl. Corresponds to the /song/url/v1/302 API endpoint.

```APIDOC
## song_url_v1_302

### Description
Retrieves the client song download URL (302 redirect). First attempts download/url/v1, then falls back to player/url/v1, and finally returns a 302 response with a redirectUrl.

### Method
POST

### Endpoint
/song/url/v1/302

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for the song URL v1 302 request.

### Response
#### Success Response (302)
- **ApiResponse** - The API response containing a 302 redirect with a redirectUrl.
```

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

### Converting Result to Option with Ok Value

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

The `ok()` method converts a `Result<T, E>` into an `Option<T>`. It consumes the `Result` and returns `Some(T)` if it was `Ok`, otherwise `None`.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.ok(), Some(2));

let x: Result<u32, &str> = Err("Nothing here");
assert_eq!(x.ok(), None);
```

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

### personalized_mv

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Fetches personalized MV recommendations. Corresponds to the /personalized/mv endpoint.

```APIDOC
## personalized_mv

### Description
Fetches personalized MV recommendations.

### Method
POST

### Endpoint
/personalized/mv

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching personalized MVs.
```

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

### pub fn unwrap(self) -> T

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Returns the contained `Ok` value, consuming the `self` value. Panics if the value is an `Err`.

```APIDOC
## pub fn unwrap(self) -> T

### Description
Returns the contained `Ok` value, consuming the `self` value. Panics if the value is an `Err`.

### Method
(Implicitly called on a Result object)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
(No specific example provided in source, but usage is similar to `expect` without a custom message)

### Response
#### Success Response (200)
Returns the contained `Ok` value.

#### Response Example
(No specific example provided, but it returns the `Ok` value or panics)
```

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

### as_ref

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Converts `&Result<T, E>` into `Result<&T, &E>`.

```APIDOC
## as_ref

### Description
Converts a reference to a `Result<T, E>` into a `Result` containing references to the contained values. This allows borrowing the contents without consuming the original `Result`.

### Method
`as_ref()`

### Parameters
None

### Response
- `Ok(&T)` if the original `Result` was `Ok(T)`.
- `Err(&E)` if the original `Result` was `Err(E)`.

### Example
```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.as_ref(), Ok(&2));

let x: Result<u32, &str> = Err("Error");
assert_eq!(x.as_ref(), Err(&"Error"));
```
```

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

### resource_like

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Likes or unlikes a resource. Corresponds to the /resource/like endpoint.

```APIDOC
## resource_like

### Description
Likes or unlikes a resource.

### Method
POST

### Endpoint
/resource/like

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for liking or unliking the resource.

### Response
#### Success Response (200)
- **ApiResponse** - The API response indicating success or failure of the like/unlike operation.
```

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

### song_music_detail

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves the audio quality details for a song. Corresponds to the /song/music/detail API endpoint.

```APIDOC
## song_music_detail

### Description
Retrieves the audio quality details for a song.

### Method
POST

### Endpoint
/song/music/detail

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for the song music detail request.

### Response
#### Success Response (200)
- **ApiResponse** - The API response containing the song audio quality details.
```

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

### cloud_upload_complete_pub

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Publishes a completed cloud upload. Corresponds to the /cloud/upload/complete (publishing step) endpoint.

```APIDOC
## POST /cloud/upload/complete/pub

### Description
Publishes a completed cloud upload.

### Method
POST

### Endpoint
/cloud/upload/complete/pub

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### pub fn expect(self, msg: &str) -> T

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Returns the contained `Ok` value, consuming the `self` value. Panics if the value is an `Err`.

```APIDOC
## pub fn expect(self, msg: &str) -> T

### Description
Returns the contained `Ok` value, consuming the `self` value. Panics if the value is an `Err`, with a panic message including the passed message, and the content of the `Err`.

### Method
(Implicitly called on a Result object)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let x: Result<u32, &str> = Err("emergency failure");
x.expect("Testing expect"); // panics with `Testing expect: emergency failure`
```

### Response
#### Success Response (200)
Returns the contained `Ok` value.

#### Response Example
(See Request Example, but note this function panics on error)
```

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

### vip_tasks

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Fetches the list of available VIP tasks. Corresponds to the /vip/tasks endpoint.

```APIDOC
## POST /vip/tasks

### Description
Fetches the list of available VIP tasks.

### Method
POST

### Endpoint
/vip/tasks

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### yunbei_today

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves today's Yunbei sign-in information. Corresponds to the /yunbei/today endpoint.

```APIDOC
## POST /yunbei/today

### Description
Retrieves today's Yunbei sign-in information.

### Method
POST

### Endpoint
/yunbei/today

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### album_detail

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves details for digital albums. Corresponds to the /album/detail endpoint.

```APIDOC
## album_detail

### Description
Retrieves details for digital albums.

### Method
GET

### Endpoint
/album/detail

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### artist_new_mv

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves new music videos from followed artists. Corresponds to the /artist/new/mv endpoint.

```APIDOC
## artist_new_mv

### Description
Retrieves new music videos from followed artists.

### Method
GET

### Endpoint
/artist/new/mv

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### user_binding

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves user binding information. Corresponds to the /user/bindling endpoint.

```APIDOC
## POST /user/bindling

### Description
Retrieves user binding information.

### Method
POST

### Endpoint
/user/bindling

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching user binding details.
```

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

### user_detail

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves the user's detailed information. Corresponds to the /user/detail endpoint.

```APIDOC
## POST /user/detail

### Description
Retrieves the user's detailed information.

### Method
POST

### Endpoint
/user/detail

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching user details.
```

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

### RequestOption Struct Definition

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.RequestOption.html

Defines the structure for request options, including fields for crypto type, cookies, user agent, proxy, real IP, random Chinese IP flag, error reporting flag, domain, and check token flag.

```rust
pub struct RequestOption {
    pub crypto: CryptoType,
    pub cookie: Option<String>,
    pub ua: Option<String>,
    pub proxy: Option<String>,
    pub real_ip: Option<String>,
    pub random_cn_ip: bool,
    pub e_r: Option<bool>,
    pub domain: Option<String>,
    pub check_token: bool,
}
```

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

### Using or to Provide a Default Error

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Illustrates the `or` method, which returns the `Ok` value of `self` if it's `Ok`, otherwise returns the provided `Result`. Note that arguments to `or` are eagerly evaluated.

```rust
let x: Result<u32, &str> = Ok(2);
let y: Result<u32, &str> = Err("late error");
assert_eq!(x.or(y), Ok(2));

let x: Result<u32, &str> = Err("early error");
let y: Result<u32, &str> = Ok(2);
assert_eq!(x.or(y), Ok(2));

let x: Result<u32, &str> = Err("not a 2");
let y: Result<u32, &str> = Err("late error");
assert_eq!(x.or(y), Err("late error"));

let x: Result<u32, &str> = Ok(2);
let y: Result<u32, &str> = Ok(100);
assert_eq!(x.or(y), Ok(2));
```

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

### likelist

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves the list of liked music tracks. Corresponds to the /likelist API endpoint.

```APIDOC
## likelist

### Description
Retrieves the list of liked music tracks.

### Method
POST

### Endpoint
/likelist

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for the likelist request.

### Response
#### Success Response (200)
- **ApiResponse** - The API response containing the list of liked music.
```

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

### user_cloud_detail

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves details of songs in the user's cloud drive. Corresponds to the /user/cloud/detail endpoint.

```APIDOC
## POST /user/cloud/detail

### Description
Retrieves details of songs in the user's cloud drive.

### Method
POST

### Endpoint
/user/cloud/detail

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for fetching user cloud song details.
```

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

### album

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves album details. Corresponds to the /album endpoint.

```APIDOC
## album

### Description
Retrieves album details.

### Method
GET

### Endpoint
/album

### Parameters
#### Query Parameters
- **query** (Query) - Required - Query parameters for the request.
```

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

### style_playlist

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/request/struct.ApiClient.html

Retrieves playlists based on musical style. Corresponds to the /style/playlist endpoint.

```APIDOC
## style_playlist

### Description
Retrieves playlists categorized by musical style.

### Method
POST

### Endpoint
/style/playlist

### Parameters
#### Query Parameters
- **query** (Query) - Required - Parameters for retrieving playlists by style.

### Response
#### Success Response (200)
- **ApiResponse** - The API response containing playlists based on the specified style.
```

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

### linuxapi

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/crypto/index.html

Performs Linux API encryption using single-layer AES-128-ECB.

```APIDOC
## linuxapi

### Description
Performs Linux API encryption using single-layer AES-128-ECB.

### Method
Not specified (likely a function call within the library)

### Endpoint
Not applicable (library function)

### Parameters
Not specified

### Request Example
Not applicable

### Response
Not specified
```

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

### unwrap_or_default

Source: https://docs.rs/ncm-api-rs/latest/ncm_api_rs/error/type.Result.html

Returns the contained Ok value or a default value if the Result is Err.

```APIDOC
## unwrap_or_default

### Description
Consumes the `self` argument then, if `Ok`, returns the contained value, otherwise if `Err`, returns the default value for that type.

### Method
`unwrap_or_default()`

### Parameters
None

### Request Example
```rust
let good_year_from_input = "1909";
let bad_year_from_input = "190blarg";
let good_year = good_year_from_input.parse().unwrap_or_default();
let bad_year = bad_year_from_input.parse().unwrap_or_default();

assert_eq!(1909, good_year);
assert_eq!(0, bad_year);
```

### Response
#### Success Response
- `T`: The contained `Ok` value or the default value if `Err`.
```
Tokens:
Raw