Struct CodeQuery 

pub struct CodeQuery { /* private fields */ }

Query builder for the getDataCode endpoint.

Constraints enforced at build time:

• DB must be non-empty ASCII and must not contain commas.
• CODE entries must be non-empty ASCII, must not contain commas, and the number of entries must be between 1 and 1250.
• startDate and endDate must be YYYY or YYYYXX (XX=01..12), and if both are set they must have the same format and startDate <= endDate.

Examples

use boj_client::query::{CodeQuery, Format, Language};

let _query = CodeQuery::new("CO", vec!["TK99F1000601GCQ01000".to_string()])?
    .with_format(Format::Json)
    .with_lang(Language::En)
    .with_start_date("202401")?
    .with_end_date("202402")?;

Implementations

impl CodeQuery

pub fn new(db: impl Into<String>, codes: Vec<String>) -> Result<Self, BojError>

Creates a getDataCode query.

Examples

use boj_client::query::CodeQuery;

let _query = CodeQuery::new("CO", vec!["TK99F1000601GCQ01000".to_string()])?;

Errors

Returns BojError if db or codes violate API constraints.

pub fn with_format(self, format: Format) -> Self

Sets the response format (json or csv).

Examples

use boj_client::query::{CodeQuery, Format};

let _query = CodeQuery::new("CO", vec!["TK99F1000601GCQ01000".to_string()])?
    .with_format(Format::Csv);

pub fn with_lang(self, lang: Language) -> Self

Sets response language (jp or en).

Examples

use boj_client::query::{CodeQuery, Language};

let _query = CodeQuery::new("CO", vec!["TK99F1000601GCQ01000".to_string()])?
    .with_lang(Language::Jp);

pub fn with_start_date(self, value: impl Into<String>) -> Result<Self, BojError>

Sets startDate.

Accepted format is YYYY or YYYYXX (XX=01..12).

Examples

use boj_client::query::CodeQuery;

let _query = CodeQuery::new("CO", vec!["TK99F1000601GCQ01000".to_string()])?
    .with_start_date("2024")?;

Errors

Returns BojError if the value format is invalid or if endDate is already set and the date order becomes invalid.

pub fn with_end_date(self, value: impl Into<String>) -> Result<Self, BojError>

Sets endDate.

Accepted format is YYYY or YYYYXX (XX=01..12).

Examples

use boj_client::query::CodeQuery;

let _query = CodeQuery::new("CO", vec!["TK99F1000601GCQ01000".to_string()])?
    .with_end_date("202402")?;

Errors

Returns BojError if the value format is invalid or if startDate is already set and the date order becomes invalid.

pub fn with_start_position(self, start_position: u32) -> Result<Self, BojError>

Sets startPosition.

Examples

use boj_client::query::CodeQuery;

let _query = CodeQuery::new("CO", vec!["TK99F1000601GCQ01000".to_string()])?
    .with_start_position(1)?;

Errors

Returns BojError when start_position is 0.

Trait Implementations

impl Clone for CodeQuery

fn clone(&self) -> CodeQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeQuery

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

Formats the value using the given formatter.

impl PartialEq for CodeQuery

fn eq(&self, other: &CodeQuery) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CodeQuery

impl StructuralPartialEq for CodeQuery