Struct kotlin_poet_rs::spec::Package

pub struct Package { /* private fields */ }

Fully qualified package name, may be parsed from &str

Examples

Parse from string

use std::str::FromStr;
use kotlin_poet_rs::io::RenderKotlin;
use kotlin_poet_rs::spec::Package;

let package = Package::from_str("io.github.lexadiky").unwrap();

assert_eq!(
    package.render_string(),
    "io.github.lexadiky"
);

Create from Vec

use std::str::FromStr;
use kotlin_poet_rs::io::RenderKotlin;
use kotlin_poet_rs::spec::{Name, Package};

let package = Package::from(vec![
    Name::from("io"),
    Name::from("github"),
    Name::from("lexadiky"),
]);

assert_eq!(
    package.render_string(),
    "io.github.lexadiky"
);

Create root

use std::str::FromStr;
use kotlin_poet_rs::io::RenderKotlin;
use kotlin_poet_rs::spec::{Name, Package};

let package = Package::root();

assert_eq!(
    package.render_string(),
    ""
);

Implementations

impl Package

pub fn from(names: Vec<Name>) -> Package

Creates new package from Name parts

pub fn root() -> Package

Create root package

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl From<&str> for Package

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for Package

type Err = SemanticConversionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Package

fn eq(&self, other: &Package) -> 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 RenderKotlin for Package

fn render_into(&self, block: &mut CodeBlock)

Renders Kotlin code into CodeBlock.

fn render_string(&self) -> String

Shortcut method for converting RenderKotlin::render_into output into String.

impl StructuralPartialEq for Package