Struct kotlin_poet_rs::spec::Class

pub struct Class { /* private fields */ }

Defines Kotlin’s class like entity. This could represent any ‘flavour’ of class: enum, interface, e.t.c. To change type of class please use Class::inheritance_modifier.

#Example

Simple class

use kotlin_poet_rs::io::RenderKotlin;
use kotlin_poet_rs::spec::{Class, Name};

let class = Class::new(Name::from("Person"));

 assert_eq!(class.render_string(), "public final class Person {\n\n}");

Interface

use kotlin_poet_rs::io::RenderKotlin;
use kotlin_poet_rs::spec::{Class, ClassInheritanceModifier, Name};

let class = Class::new(Name::from("Person"))
    .inheritance_modifier(ClassInheritanceModifier::Interface);

 assert_eq!(class.render_string(), "public interface Person {\n\n}");

Implementations

impl Class

pub fn new<NameLike: Into<Name>>(name: NameLike) -> Self

Creates new plain final class.

pub fn inner(self, flag: bool) -> Self

Marks class as inner

pub fn visibility_modifier( self, visibility_modifier: VisibilityModifier, ) -> Self

Set’s class visibility modifier

pub fn inheritance_modifier( self, inheritance_modifier: ClassInheritanceModifier, ) -> Self

Changes class type

pub fn property(self, property: Property) -> Self

Adds property to this class. Properties in body will appear in order this method is called.

pub fn function(self, function: Function) -> Self

Adds function to this class. Functions in body will appear in order this method is called.

pub fn subclass(self, subclass: Class) -> Self

Adds subclass to this class. Subclasses in body will appear in order this method is called.

pub fn enum_instance<NameLike: Into<Name>>( self, name: NameLike, arguments: Vec<Argument>, ) -> Self

Adds enum instance to this class. Enum instances in body will appear in order this method is called. This method is only valid for enum classes. To change class type to enum please use Class::inheritance_modifier.

pub fn primary_constructor( self, primary_constructor: PrimaryConstructor, ) -> Self

Adds primary constructor to this class.

pub fn secondary_constructor( self, secondary_constructor: SecondaryConstructor, ) -> Self

Adds secondary constructor to this class. Secondary constructors in body will appear in order this method is called.

pub fn init<CodeBlockLike: Into<CodeBlock>>(self, block: CodeBlockLike) -> Self

Adds init block to this class. Init blocks in body will appear in order this method is called.

pub fn companion_object(self, companion_object: CompanionObject) -> Self

Adds companion object to this class.

pub fn generic_parameter(self, generic_parameter: GenericParameter) -> Self

Adds GenericParameter to this class. Could be called multiple times to have multiple generic parameters.

pub fn inherits<TypeLike: Into<Type>>(self, parent_type: TypeLike) -> Self

Adds parent class / interface to this class.

pub fn annotation(self, annotation: Annotation) -> Self

Adds Annotation to this entity. They will appear in order this method is called.

pub fn kdoc<KDocLike: Into<KDoc>>(self, kdoc: KDocLike) -> Self

Adds [KDoc] to this entity. In case of multiple calls, KDocs will be merged, see [KDoc::merge].

Trait Implementations

impl Clone for Class

fn clone(&self) -> Class

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Class

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

Formats the value using the given formatter.

impl RenderKotlin for Class

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.