Struct Comment

pub struct Comment { /* private fields */ }

Represents a ‘normal’, non documentation comment in Kotlin.

Entities that support comments should usually store them as Vec and aggregate multiple comments.

Example

use kotlin_poet_rs::spec::Comment;
use kotlin_poet_rs::io::RenderKotlin;

let comment = Comment::new()
    .append("Hello, World!");

assert_eq!(
   "// Hello, World!",
   comment.render_string()
)

Implementations

impl Comment

pub fn new() -> Comment

Creates new, empty comment

pub fn append(self, content: &str) -> Comment

Appends content to the comment. If content contains new line will be automatically converted to block comment

Trait Implementations

impl Clone for Comment

fn clone(&self) -> Comment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Comment

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

Formats the value using the given formatter.

impl From<&str> for Comment

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for Comment

type Err = ()

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 RenderKotlin for Comment

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.