Struct kotlin_poet_rs::spec::Annotation

pub struct Annotation { /* private fields */ }

Represents an annotation in Kotlin. Used for adding meta information for code entities.

Official documentation reference

Examples

use std::str::FromStr;
use kotlin_poet_rs::io::RenderKotlin;
use kotlin_poet_rs::spec::{Annotation, Argument, ClassLikeTypeName, CodeBlock, Name, Package};

let annotation = Annotation::new(
    ClassLikeTypeName::top_level(
        Package::from_str("a.b.c").unwrap(),
        Name::from("MyAnnotation")
    )
).argument(
    Argument::new_named("value", CodeBlock::atom("1"))
).argument(
    Argument::new_named("name", CodeBlock::atom("\"name_value\""))
);

assert_eq!(
    annotation.render_string(),
    "@a.b.c.MyAnnotation(value = 1, name = \"name_value\")"
);

Implementations

impl Annotation

pub fn new<ClassLikeTypeNameLike: Into<ClassLikeTypeName>>( type_name: ClassLikeTypeNameLike, ) -> Self

pub fn argument(self, argument: Argument) -> Self

pub fn target(self, target: AnnotationTarget) -> Self

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl RenderKotlin for Annotation

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.