Struct LayerQuery

Source

pub struct LayerQuery { /* private fields */ }

Expand description

Query builder for the getDataLayer endpoint.

Constraints enforced at build time:

DB must be non-empty ASCII and must not contain commas.
LAYER must contain between 1 and 5 entries.
Each layer entry must be either * or a positive integer.
Date format depends on frequency:
- CY / FY: YYYY
- CH / FH: YYYYXX where XX is 01..02
- Q: YYYYXX where XX is 01..04
- M / W / D: YYYYXX where XX is 01..12
If both dates are set they must share the same format and satisfy startDate <= endDate.

§Examples

use boj_client::query::{Format, Frequency, Language, LayerQuery};

let _query = LayerQuery::new("BP01", Frequency::Q, vec!["1".to_string(), "*".to_string()])?
    .with_format(Format::Json)
    .with_lang(Language::En)
    .with_start_date("202401")?
    .with_end_date("202404")?;

Implementations§

Source §

impl LayerQuery

Source

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

Creates a getDataLayer query.

§Examples

use boj_client::query::{Frequency, LayerQuery};

let _query = LayerQuery::new("BP01", Frequency::M, vec!["1".to_string()])?;

§Errors

Returns BojError if db, layers, or parsed layer values violate API constraints.

Source

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

Sets the response format (json or csv).

§Examples

use boj_client::query::{Format, Frequency, LayerQuery};

let _query = LayerQuery::new("BP01", Frequency::M, vec!["1".to_string()])?
    .with_format(Format::Csv);

Source

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

Sets response language (jp or en).

§Examples

use boj_client::query::{Frequency, Language, LayerQuery};

let _query = LayerQuery::new("BP01", Frequency::M, vec!["1".to_string()])?
    .with_lang(Language::Jp);

Source

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

Sets startDate using the date format implied by frequency.

§Examples

use boj_client::query::{Frequency, LayerQuery};

let _query = LayerQuery::new("BP01", Frequency::Q, vec!["1".to_string()])?
    .with_start_date("202401")?;

§Errors

Returns BojError if the date format is invalid for the selected frequency, or if endDate is already set and the date order is invalid.

Source

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

Sets endDate using the date format implied by frequency.

§Examples

use boj_client::query::{Frequency, LayerQuery};

let _query = LayerQuery::new("BP01", Frequency::Q, vec!["1".to_string()])?
    .with_end_date("202404")?;

§Errors

Returns BojError if the date format is invalid for the selected frequency, or if startDate is already set and the date order is invalid.

Source

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

Sets startPosition.

§Examples

use boj_client::query::{Frequency, LayerQuery};

let _query = LayerQuery::new("BP01", Frequency::M, vec!["1".to_string()])?
    .with_start_position(10)?;