https://github.com/dearblue/ruby-ioposrw

pread/pwrite for ruby
https://github.com/dearblue/ruby-ioposrw

io pread pwrite ruby

Last synced: 3 days ago
JSON representation

pread/pwrite for ruby

• Host: GitHub
• URL: https://github.com/dearblue/ruby-ioposrw
• Owner: dearblue
• License: bsd-2-clause
• Created: 2017-03-08T11:43:41.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-01-14T07:13:27.000Z (almost 7 years ago)
• Last Synced: 2024-12-01T03:13:14.757Z (21 days ago)
• Topics: io, pread, pwrite, ruby
• Language: C
• Size: 24.4 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.ja.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ioposrw

位置指定IO読み書きメソッド追加拡張ライブラリ

  * Package name: [ioposrw](https://rubygems.org/gems/ioposrw)

  * Version: 0.4

  * Production quality: TECHNICAL PREVIEW, METASTABLE

  * License: [BSD-2-clause License](LICENSE)

  * Author: dearblue ()

  * Project Page: 

* * * *

  * [QUICK REFERENCE](QUICKREF.md)

  * [HISTORY](HISTORY.ja.md) (In Japanese)

## これは何?

ioposrw は IO インスタンスに位置指定読み書き機能を追加する拡張ライブラリです。

この機能は ``IO#readat`` / ``IO#writeat`` によって提供されます。

これらのメソッドは、元々ある ``IO#read`` / ``IO#write`` によって更新されるファイル位置ポインタに影響されません。

マルチスレッド動作中に同じファイルインスタンスの別の領域を読み書きしても、想定通りの動作が期待できます。

追加の機能として、``StringIO#readat`` / ``StringIO#writeat`` も実装してあります (実際に利用する場合は、``require "ioposrw/stringio"`` を行って下さい)。

## どう使うのか?

ライブラリの読み込み:

```ruby:ruby

require "ioposrw"

```

ファイルの読み込み:

```ruby:ruby

File.open("sample.txt") do |file|

  buf = ""

  file.readat(200, 100, buf) # sample.txt の先頭 200 バイト位置から

                             # 100 バイトを buf に読み込む

end

```

ファイルの書き込み:

```ruby:ruby

File.open("sample.txt", "w") do |file|

  buf = "ごにょごにょ"

  file.writeat(200, buf) # sample.txt の先頭 200 バイト位置に buf を書き込む

end

```

## 注意事項について

  * Windows 上では、``IO#readat / IO#writeat`` を呼び出すとファイルポインタ (IO#pos) が指定位置の次に変更されます (このことは丁度 ``IO#pos=`` と ``IO#read`` を呼び出した後の状態と考えてください)。

    これは Windows 自身に伴う仕様となります。

## 内部の実装方法

POSIX システムコールの ``pread(2)`` / ``pwrite(2)`` を中心に実装しました。

Windows 環境では ``OVERRAPPED`` 構造体を与えた ``ReadFile`` / ``WriteFile`` をそれぞれ用いて ``pread`` / ``pwrite`` 関数を構築し、あとは同じです。