buffer.h File Reference

(002ae526ff2881554dc059e7bcf3565349facc20)

#include "ruby/ruby.h"
#include "ruby/internal/config.h"

Include dependency graph for buffer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	RB_IO_BUFFER_EXPERIMENTAL   1
#define	RUBY_IO_BUFFER_VERSION   4

Enumerations
enum	rb_io_buffer_flags {   RB_IO_BUFFER_EXTERNAL = 1 , RB_IO_BUFFER_INTERNAL = 2 , RB_IO_BUFFER_MAPPED = 4 , RB_IO_BUFFER_SHARED = 8 ,   RB_IO_BUFFER_PRIVATE = 64 , RB_IO_BUFFER_READONLY = 128 , RB_IO_BUFFER_FILE = 256 }
enum	rb_io_buffer_endian { RB_IO_BUFFER_LITTLE_ENDIAN = 4 , RB_IO_BUFFER_BIG_ENDIAN = 8 , RB_IO_BUFFER_HOST_ENDIAN = RB_IO_BUFFER_LITTLE_ENDIAN , RB_IO_BUFFER_NETWORK_ENDIAN = RB_IO_BUFFER_BIG_ENDIAN }

Functions
int	rb_io_buffer_p (VALUE self)
int	rb_io_buffer_readonly_p (VALUE self)
VALUE	rb_io_buffer_new (void *base, size_t size, enum rb_io_buffer_flags flags)
VALUE	rb_io_buffer_new_locked (void *base, size_t size, enum rb_io_buffer_flags flags)
VALUE	rb_io_buffer_map (VALUE io, size_t size, rb_off_t offset, enum rb_io_buffer_flags flags)
VALUE	rb_io_buffer_lock (VALUE self)
VALUE	rb_io_buffer_unlock (VALUE self)
int	rb_io_buffer_try_unlock (VALUE self)
VALUE	rb_io_buffer_free (VALUE self)
VALUE	rb_io_buffer_free_locked (VALUE self)
enum rb_io_buffer_flags	rb_io_buffer_get_bytes (VALUE self, void **base, size_t *size)
void	rb_io_buffer_get_bytes_for_reading (VALUE self, const void **base, size_t *size)
void	rb_io_buffer_get_bytes_for_writing (VALUE self, void **base, size_t *size)
VALUE	rb_io_buffer_locked_for_reading (VALUE self, VALUE(*callback)(const void *base, size_t size, VALUE argument), VALUE argument)
VALUE	rb_io_buffer_locked_for_writing (VALUE self, VALUE(*callback)(void *base, size_t size, VALUE argument), VALUE argument)
VALUE	rb_io_buffer_transfer (VALUE self)
void	rb_io_buffer_resize (VALUE self, size_t size)
void	rb_io_buffer_advance (VALUE self, size_t amount)
void	rb_io_buffer_clear (VALUE self, uint8_t value, size_t offset, size_t length)
VALUE	rb_io_buffer_read (VALUE self, VALUE io, size_t offset, size_t length)
VALUE	rb_io_buffer_pread (VALUE self, VALUE io, rb_off_t from, size_t offset, size_t length)
VALUE	rb_io_buffer_write (VALUE self, VALUE io, size_t offset, size_t length)
VALUE	rb_io_buffer_pwrite (VALUE self, VALUE io, rb_off_t from, size_t offset, size_t length)

Variables
VALUE	rb_cIOBuffer
VALUE	rb_cIOBufferStorage
VALUE	rb_cIOBufferSlice
size_t	RUBY_IO_BUFFER_PAGE_SIZE
size_t	RUBY_IO_BUFFER_MAP_ALIGNMENT
size_t	RUBY_IO_BUFFER_DEFAULT_SIZE

Detailed Description

Author

Samuel Williams

Date

Fri 2 Jul 2021 16:29:01 NZST

Copyright

Copyright (C) 2021 Samuel Williams

This file is a part of the programming language Ruby. Permission is hereby granted, to either redistribute and/or modify this file, provided that the conditions mentioned in the file COPYING are met. Consult the file for details.

Definition in file buffer.h.

Macro Definition Documentation

RB_IO_BUFFER_EXPERIMENTAL

#define RB_IO_BUFFER_EXPERIMENTAL   1

Definition at line 22 of file buffer.h.

RUBY_IO_BUFFER_VERSION

#define RUBY_IO_BUFFER_VERSION   4

Definition at line 27 of file buffer.h.

Enumeration Type Documentation

rb_io_buffer_endian

enum rb_io_buffer_endian

Definition at line 78 of file buffer.h.

rb_io_buffer_flags

enum rb_io_buffer_flags

Definition at line 54 of file buffer.h.

Function Documentation

rb_io_buffer_advance()

void rb_io_buffer_advance	(	VALUE	self,
		size_t	amount
	)

Definition at line 2390 of file io_buffer.c.

rb_io_buffer_clear()

void rb_io_buffer_clear	(	VALUE	self,
		uint8_t	value,
		size_t	offset,
		size_t	length
	)

Definition at line 3674 of file io_buffer.c.

rb_io_buffer_free()

VALUE rb_io_buffer_free

(

VALUE

self

)

Definition at line 1989 of file io_buffer.c.

rb_io_buffer_free_locked()

VALUE rb_io_buffer_free_locked

(

VALUE

self

)

Definition at line 2045 of file io_buffer.c.

rb_io_buffer_get_bytes()

enum rb_io_buffer_flags rb_io_buffer_get_bytes	(	VALUE	self,
		void **	base,
		size_t *	size
	)

Definition at line 1277 of file io_buffer.c.

rb_io_buffer_get_bytes_for_reading()

void rb_io_buffer_get_bytes_for_reading	(	VALUE	self,
		const void **	base,
		size_t *	size
	)

Definition at line 1349 of file io_buffer.c.

rb_io_buffer_get_bytes_for_writing()

void rb_io_buffer_get_bytes_for_writing	(	VALUE	self,
		void **	base,
		size_t *	size
	)

Definition at line 1323 of file io_buffer.c.

rb_io_buffer_lock()

VALUE rb_io_buffer_lock

(

VALUE

self

)

Definition at line 1824 of file io_buffer.c.

rb_io_buffer_locked_for_reading()

VALUE rb_io_buffer_locked_for_reading	(	VALUE	self,
		VALUE(*)(const void *base, size_t size, VALUE argument)	callback,
		VALUE	argument
	)

Definition at line 1899 of file io_buffer.c.

rb_io_buffer_locked_for_writing()

VALUE rb_io_buffer_locked_for_writing	(	VALUE	self,
		VALUE(*)(void *base, size_t size, VALUE argument)	callback,
		VALUE	argument
	)

Definition at line 1933 of file io_buffer.c.

rb_io_buffer_map()

VALUE rb_io_buffer_map	(	VALUE	io,
		size_t	size,
		rb_off_t	offset,
		enum rb_io_buffer_flags	flags
	)

Definition at line 962 of file io_buffer.c.

rb_io_buffer_new()

VALUE rb_io_buffer_new	(	void *	base,
		size_t	size,
		enum rb_io_buffer_flags	flags
	)

Definition at line 915 of file io_buffer.c.

rb_io_buffer_new_locked()

VALUE rb_io_buffer_new_locked	(	void *	base,
		size_t	size,
		enum rb_io_buffer_flags	flags
	)

Definition at line 927 of file io_buffer.c.

rb_io_buffer_p()

int rb_io_buffer_p

(

VALUE

self

)

Definition at line 391 of file io_buffer.c.

rb_io_buffer_pread()

VALUE rb_io_buffer_pread	(	VALUE	self,
		VALUE	io,
		rb_off_t	from,
		size_t	offset,
		size_t	length
	)

Definition at line 3923 of file io_buffer.c.

rb_io_buffer_pwrite()

VALUE rb_io_buffer_pwrite	(	VALUE	self,
		VALUE	io,
		rb_off_t	from,
		size_t	offset,
		size_t	length
	)

Definition at line 4106 of file io_buffer.c.

rb_io_buffer_read()

VALUE rb_io_buffer_read	(	VALUE	self,
		VALUE	io,
		size_t	offset,
		size_t	length
	)

Definition at line 3829 of file io_buffer.c.

rb_io_buffer_readonly_p()

int rb_io_buffer_readonly_p

(

VALUE

self

)

Definition at line 1785 of file io_buffer.c.

rb_io_buffer_resize()

void rb_io_buffer_resize	(	VALUE	self,
		size_t	size
	)

Definition at line 2511 of file io_buffer.c.

rb_io_buffer_transfer()

VALUE rb_io_buffer_transfer

(

VALUE

self

)

Definition at line 2311 of file io_buffer.c.

rb_io_buffer_try_unlock()

int rb_io_buffer_try_unlock

(

VALUE

self

)

Definition at line 1856 of file io_buffer.c.

rb_io_buffer_unlock()

VALUE rb_io_buffer_unlock

(

VALUE

self

)

Definition at line 1846 of file io_buffer.c.

rb_io_buffer_write()

VALUE rb_io_buffer_write	(	VALUE	self,
		VALUE	io,
		size_t	offset,
		size_t	length
	)

Definition at line 4020 of file io_buffer.c.

Variable Documentation

rb_cIOBuffer

VALUE rb_cIOBuffer

extern

Definition at line 26 of file io_buffer.c.

rb_cIOBufferSlice

VALUE rb_cIOBufferSlice

extern

Definition at line 28 of file io_buffer.c.

rb_cIOBufferStorage

VALUE rb_cIOBufferStorage

extern

Definition at line 27 of file io_buffer.c.

RUBY_IO_BUFFER_DEFAULT_SIZE

size_t RUBY_IO_BUFFER_DEFAULT_SIZE

extern

Definition at line 37 of file io_buffer.c.

RUBY_IO_BUFFER_MAP_ALIGNMENT

size_t RUBY_IO_BUFFER_MAP_ALIGNMENT

extern

Definition at line 36 of file io_buffer.c.

RUBY_IO_BUFFER_PAGE_SIZE

size_t RUBY_IO_BUFFER_PAGE_SIZE

extern

Definition at line 35 of file io_buffer.c.