class RakuAST::Doc::Paragraph

Contains the information about a RakuDoc paragraph

class RakuAST::Doc::Paragraph { }

The RakuAST::Doc::Paragraph class contains the information about a logical paragraph in a RakuDoc block.

Support for RakuAST functionality is available in language version 6.e+ and was added in Rakudo compiler release 2023.02. In earlier language versions it is only available when specifying:

use experimental :rakuast;

Object introspection

RakuAST::Doc::Paragraph objects are typically created when parsing Raku Programming Language code that has RakuDoc markers in it. So most developers will only need to know how to introspect the objects created.

method atoms

.put for $paragraphs.atoms;
# Text before ␤B<and>␤ after markup␤

Returns the atoms of the paragraph. These are generally a mix of strings and RakuAST::Doc::Markup objects.

method Str

put $paragraph;  # Text before B<and> after markup␤␤

Returns the string for the paragraph, with any markup stringified.

method raku

# method .gist falls back to .raku
say $block;  # RakuAST::Doc::Paragraph.new(...

Returns the string that is needed for the creation of the paragraph using RakuAST calls.

Object creation

One seldom creates RakuAST::Doc::Paragraph objects directly. This documentation is intended for those few people who'd like to devise their own way of programmatically building a RakuAST::Doc::Paragraph object.

method new

method new(*@atoms)

The new method must be called to create a new RakuAST::Doc::Paragraph object. It takes any number of positional arguments as the atoms of the logical paragraph, where an atom is either a string or a RakuAST::Doc::Markup object.

Typically a RakuAST::Doc::Paragraph object is only created if a logical paragraph has at least one markup object.

my $paragraph = RakuAST::Doc::Paragraph.new(
  "Text before ",
  RakuAST::Doc::Markup.new(:letter<B>, :atoms("and")),
  " after markup\n"
);

Object modification

method add-atom

$paragraph.add-atom("baz\n");

Add an atom: should be a string, or a RakuAST::Doc::Markup object.

See Also

Native integer

class Allomorph

Dual value number and string

Thing/object

Abstract representation of a piece of source code

class atomicint

Integer (native storage at the platform's atomic operation size)

Code object with its own lexical scope

class CallFrame

Captures the current frame state

Code object

class Collation

Encapsulates instructions about how strings should be sorted

Information related to the compiler that is being used

Complex number

class ComplexStr

Dual value complex number and string

Object that can be treated as both a string and number

class CurrentThreadScheduler

Scheduler that synchronously executes code on the current thread

Calendar date

Calendar date with time

class Distribution::Hash

Distribution::Hash

class Distribution::Locally

Distribution::Locally

class Distribution::Path

Distribution::Path

class Distribution::Resource

Every one of the resources installed with a distribution

Length of time

class Encoding::Registry

Management of available encodings

Rational number (arbitrary-precision)

class ForeignCode

Rakudo-specific class that wraps around code in other languages (generally NQP)

Convert values to a string given a format specification

class Formatter

Produce Callable for given format specification

An object for performing batches of work in parallel with ordered output

class HyperWhatever

Placeholder for multiple unspecified values/arguments

Specific moment in time

Integer (arbitrary-precision)

Dual value integer and string

Logical superposition of values

Tagged location in the source code

class Lock::Async

A non-blocking, non-re-entrant, mutual exclusion lock

Compile-time routine

Member function

The root of the Raku type hierarchy.

Absence of a value or a benign failure

Floating-point number

Number or object that can act as a number

Dual value floating-point number and string

Unique identification for an object

class Parameter

Element of a Signature

Perl related information

Item container with custom storage and retrieval

Performs batches of work in parallel without respecting original order.

Raku related information

package RakuAST

Namespace for holding RakuAST related classes

class RakuAST::Doc::Block

Contains the information of a RakuDoc block

class RakuAST::Doc::Declarator

Contains the declarator docs of a RakuAST object

class RakuAST::Doc::Markup

Contains the information about RakuDoc markup

Rational number (limited-precision)

Dual value rational number and string

Code object with its own lexical scope and return handling

class Routine::WrapHandle

Holds all information needed to unwrap a wrapped routine.

A mostly transparent container used for indirections

class Signature

Parameter list pattern

String of characters

class StrDistance

Contains the result of a string transformation.

Subroutine

class Submethod

Member function that is not inherited by subclasses

class Telemetry

Collect performance state for analysis

class Telemetry::Instrument::Thread

Instrument for collecting Thread data

class Telemetry::Instrument::ThreadPool

Instrument for collecting ThreadPoolScheduler data

class Telemetry::Instrument::Usage

Instrument for collecting getrusage data

class Telemetry::Period

Performance data over a period

class Telemetry::Sampler

Telemetry instrument pod

Unsigned integer (arbitrary-precision)

class ValueObjAt

Unique identification for value types

Object representation of a variable for use in traits

Module version descriptor

Placeholder for the value of an unspecified argument

class WhateverCode

Code object constructed by Whatever-priming

The Camelia image is copyright 2009 by Larry Wall. "Raku" is trademark of the Yet Another Society. All rights reserved.