Struct QueryOptions

pub struct QueryOptions {
    pub fields: Option<String>,
    pub limit: Option<u16>,
    pub offset: Option<u16>,
    pub name: Option<String>,
}

Fields for filtering output

Fields

fields: Option<String>

Specific set of fields delimited by comma

limit: Option<u16>

Limit the number of results returned

offset: Option<u16>

Offset the results returned

name: Option<String>

Filter on name

Implementations

impl QueryOptions

pub fn fields(self, fields: String) -> QueryOptions

Setting the field on an existing QueryOptions

let opt = QueryOptions::default()
    .fields("id,name,description".to_string());

pub fn limit(self, limit: u16) -> QueryOptions

Set the limit on the number of results returned

let opt = QueryOptions::default()
    .limit(10);

Examples found in repository

examples/get_service_inventory.rs (line 14)

fn main() -> Result<(),TMFError> {
    #[cfg(feature = "tmf638")]
    {

        let opt = QueryOptions::default()
            // .name("SD L3 Service CFS Instance #0123087452")
            .limit(1)
            .offset(1);

        let services = TMFClient::new("https://localhost:8001")
            .tmf638()
            .service()
            // .list(Some(opt))?;
            .list(Some(opt))?;

        let service = services.first().unwrap();

        let bandwidth = service.get_characteristics("bandwidth");

        dbg!(bandwidth);

    }

    Ok(())
}

examples/get_catalog.rs (line 13)

fn main() {
    #[cfg(feature = "tmf620")]
    {
        let mut client = TMFClient::new("https://localhost:8001");
        let filter = QueryOptions::default()
            .limit(2)
            .offset(0);
        let tmf = client.tmf620()
            .catalog()
            .list(Some(filter));
        match tmf {
            Ok(r) => {
                // It worked
                for c in r {
                    println!("Entry: {}",c.get_name())
                }
            },
            Err(e) => {
                println!("Error: {:?}",e)
            },
        }    
    }
}

examples/get_category.rs (line 14)

fn main() {
    #[cfg(feature = "tmf620")]
    {
        // Get a list of categories from TMF620
        let mut client = TMFClient::new("https://localhost:8001");
        let filter = QueryOptions::default()
            .limit(2)
            .offset(0);
        let tmf = client.tmf620()
            .category()
            .list(Some(filter));
        match tmf {
            Ok(r) => {
                // It worked
                for c in r {
                    println!("Entry: {}",c.get_name())
                }
            },
            Err(e) => {
                println!("Error: {:?}",e)
            },
        }
    }
}

pub fn offset(self, offset: u16) -> QueryOptions

Set the offset on the number of results returned

let opt = QueryOptions::default()
    .offset(5);

Examples found in repository

examples/get_service_inventory.rs (line 15)

fn main() -> Result<(),TMFError> {
    #[cfg(feature = "tmf638")]
    {

        let opt = QueryOptions::default()
            // .name("SD L3 Service CFS Instance #0123087452")
            .limit(1)
            .offset(1);

        let services = TMFClient::new("https://localhost:8001")
            .tmf638()
            .service()
            // .list(Some(opt))?;
            .list(Some(opt))?;

        let service = services.first().unwrap();

        let bandwidth = service.get_characteristics("bandwidth");

        dbg!(bandwidth);

    }

    Ok(())
}

examples/get_catalog.rs (line 14)

fn main() {
    #[cfg(feature = "tmf620")]
    {
        let mut client = TMFClient::new("https://localhost:8001");
        let filter = QueryOptions::default()
            .limit(2)
            .offset(0);
        let tmf = client.tmf620()
            .catalog()
            .list(Some(filter));
        match tmf {
            Ok(r) => {
                // It worked
                for c in r {
                    println!("Entry: {}",c.get_name())
                }
            },
            Err(e) => {
                println!("Error: {:?}",e)
            },
        }    
    }
}

examples/get_product_offering.rs (line 14)

fn main() {
    #[cfg(feature = "tmf620")]
    {
        let mut client = TMFClient::new("https://localhost:8001");
        let filter = QueryOptions::default()
        //.limit(2)
        .offset(0);
        let tmf = client.tmf620()
        .product_offering()
        .list(Some(filter));
        match tmf {
            Ok(r) => {
                // It worked
                for c in r {
                    println!("Entry: {} [{}]",c.get_name(),c.get_id())
                }
            },
            Err(e) => {
                println!("Error: {:?}",e)
            },
        }
    
    }
}

examples/get_product_offering_price.rs (line 14)

fn main() {
    #[cfg(feature = "tmf620")]
    {
        let mut client = TMFClient::new("https://localhost:8001");
        let filter = QueryOptions::default()
        //.limit(2)
        .offset(0);
        let tmf = client.tmf620()
        .product_offering_price()
        .list(Some(filter));
        match tmf {
            Ok(r) => {
                // It worked
                for c in r {
                    println!("Entry: {} [{}]",c.get_name(),c.get_id())
                }
            },
            Err(e) => {
                println!("Error: {:?}",e)
            },
        }
    }
}

examples/get_product_specification.rs (line 14)

fn main() {
    #[cfg(feature = "tmf620")]
    {
        let mut client = TMFClient::new("https://localhost:8001");
        let filter = QueryOptions::default()
        //.limit(2)
        .offset(0);
        let tmf = client.tmf620()
        .product_specification()
        .list(Some(filter));
        match tmf {
            Ok(r) => {
                // It worked
                for c in r {
                    println!("Entry: {} [{}]",c.get_name(),c.get_id())
                }
            },
            Err(e) => {
                println!("Error: {:?}",e)
            },
        }
    
    }
}

examples/get_category.rs (line 15)

fn main() {
    #[cfg(feature = "tmf620")]
    {
        // Get a list of categories from TMF620
        let mut client = TMFClient::new("https://localhost:8001");
        let filter = QueryOptions::default()
            .limit(2)
            .offset(0);
        let tmf = client.tmf620()
            .category()
            .list(Some(filter));
        match tmf {
            Ok(r) => {
                // It worked
                for c in r {
                    println!("Entry: {}",c.get_name())
                }
            },
            Err(e) => {
                println!("Error: {:?}",e)
            },
        }
    }
}

pub fn name(self, name: impl Into<String>) -> QueryOptions

Set the name to filter on

let opt = QueryOptions::default()
    .name("MyService".to_string());

This will filter the results to only include those with the specified name. If the name is not set, it will not filter on name.

Trait Implementations

impl Clone for QueryOptions

fn clone(&self) -> QueryOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryOptions

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

Formats the value using the given formatter.

impl Default for QueryOptions

fn default() -> QueryOptions

Returns the “default value” for a type.

impl From<QueryOptions> for String

fn from(val: QueryOptions) -> Self

Converts to this type from the input type.