Ruby 4.1.0dev (2026-10-27 revision ee55edef0d1f32704d7dfd37c935f9d2c8a55bb1)
Data Structures | Functions
stringy.h File Reference

(ee55edef0d1f32704d7dfd37c935f9d2c8a55bb1)

A view of a sequence of bytes owned by someone else. More...

#include "prism/compiler/exported.h"
#include "prism/compiler/nonnull.h"
#include <stddef.h>
#include <stdint.h>
Include dependency graph for stringy.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  pm_string_t
 A view of a sequence of bytes. More...
 

Functions

PRISM_EXPORTED_FUNCTION void pm_string_init (pm_string_t *string, const uint8_t *source, size_t length) PRISM_NONNULL(1)
 Initialize a string that views the given bytes.
 
PRISM_EXPORTED_FUNCTION size_t pm_string_length (const pm_string_t *string) PRISM_NONNULL(1)
 Returns the length associated with the string.
 
PRISM_EXPORTED_FUNCTION const uint8_t * pm_string_source (const pm_string_t *string) PRISM_NONNULL(1)
 Returns the start pointer associated with the string.
 

Detailed Description

A view of a sequence of bytes owned by someone else.

Definition in file stringy.h.

Function Documentation

◆ pm_string_init()

PRISM_EXPORTED_FUNCTION void pm_string_init ( pm_string_t *  string,
const uint8_t *  source,
size_t  length 
)

Initialize a string that views the given bytes.

The bytes are not copied, so they must remain valid for as long as the string is in use.

Parameters
stringThe string to initialize.
sourceThe start of the bytes.
lengthThe number of bytes.

Definition at line 23 of file stringy.c.

◆ pm_string_length()

PRISM_EXPORTED_FUNCTION size_t pm_string_length ( const pm_string_t *  string)

Returns the length associated with the string.

Parameters
stringThe string to get the length of.
Returns
The length of the string.

Definition at line 51 of file stringy.c.

◆ pm_string_source()

PRISM_EXPORTED_FUNCTION const uint8_t * pm_string_source ( const pm_string_t *  string)

Returns the start pointer associated with the string.

Parameters
stringThe string to get the start pointer of.
Returns
The start pointer of the string.

Definition at line 59 of file stringy.c.