Ruby: include/ruby/internal/arithmetic/off_t.h File Reference

Ruby 3.2.5p208 (2024-07-26 revision 31d0f1a2e7dbfb60731d1f05b868e1d578cda493)

Macros
off_t.h File Reference

Arithmetic conversion between C's `off_t` and Ruby's. More...

`#include "ruby/internal/config.h"`
`#include "ruby/internal/arithmetic/int.h"`
`#include "ruby/internal/arithmetic/long.h"`
`#include "ruby/internal/arithmetic/long_long.h"`
`#include "ruby/backward/2/long_long.h"`

Go to the source code of this file.

## Macros
#define | OFFT2NUM RB_LL2NUM
| Converts a C's `off_t` into an instance of rb_cInteger.
#define | NUM2OFFT RB_NUM2LL
| Converts an instance of rb_cNumeric into C's `off_t`.
#define | PRI_OFFT_PREFIX PRI_LL_PREFIX
| A rb_sprintf() format prefix to be used for an `off_t` parameter.

## Detailed Description

Arithmetic conversion between C's `off_t` and Ruby's.

Author
  Ruby developers ruby-.nosp@m.core.nosp@m.@ruby.nosp@m.-lan.nosp@m.g.org

Copyright
  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.

Warning
  Symbols prefixed with either `RBIMPL` or `rbimpl` are implementation details. Don't take them as canon. They could rapidly appear then vanish. The name (path) of this header file is also an implementation detail. Do not expect it to persist at the place it is now. Developers are free to move it anywhere anytime at will.

Note
  To ruby-core: remember that this header can be possibly recursively included from extension libraries written in C++. Do not expect for instance `__VA_ARGS__` is always available. We assume C99 for ruby itself but we don't assume languages of extension libraries. They could be written in C++98.

Definition in file off_t.h.

## Macro Definition Documentation

## ◆ NUM2OFFT

#define NUM2OFFT RB_NUM2LL

Converts an instance of rb_cNumeric into C's `off_t`.

Definition at line 44 of file off_t.h.

Referenced by rb_file_size().

## ◆ OFFT2NUM

#define OFFT2NUM RB_LL2NUM

Converts a C's `off_t` into an instance of rb_cInteger.

Definition at line 33 of file off_t.h.

Referenced by rb_fiber_scheduler_io_pread(), and rb_fiber_scheduler_io_pwrite().

## ◆ PRI_OFFT_PREFIX

#define PRI_OFFT_PREFIX PRI_LL_PREFIX

A rb_sprintf() format prefix to be used for an `off_t` parameter.

Definition at line 55 of file off_t.h.