非常教程

Ruby 2.4参考手册

OpenURI

OpenURI::OpenRead

Mixin用于HTTP和FTP URI。

公共实例方法

open(*rest, &block) Show source

#open为URI :: HTTP和URI :: FTP提供了“open”。

#open将可选的3个参数作为:

OpenURI::OpenRead#open([mode [, perm]] [, options]) [{|io| ... }]

如果没有给出块,#open返回一个类似IO的对象。否则它会生成IO对象并返回该块的值。IO对象使用OpenURI :: Meta进行扩展。

mode并且perm与Kernel#open相同。

但是,mode必须是读取模式,因为#open不支持写入模式(尚未)。也perm被忽略,因为它仅对文件创建有意义。

options 必须是一个散列。

带有字符串键的每个选项都为HTTP指定一个额外的标题字段。即,没有HTTP代理的FTP会被忽略。

哈希可能包含其他选项,其中键是符号:

:proxy

概要:

:proxy => "http://proxy.foo.com:8000/"
:proxy => URI.parse("http://proxy.foo.com:8000/")
:proxy => true
:proxy => false
:proxy => nil

如果:指定了代理选项,则该值应为String,URI,boolean或nil。

当给出String或URI时,它被视为代理URI。

当给出true或者未指定选项本身时,环境变量scheme\_proxy' is examined.方案'由http',https'或'ftp' 取代。

如果给出false或nil,则忽略环境变量,并直接与服务器建立连接。

:proxy_http_basic_authentication

概要:

:proxy_http_basic_authentication =>
  ["http://proxy.foo.com:8000/", "proxy-user", "proxy-password"]
:proxy_http_basic_authentication =>
  [URI.parse("http://proxy.foo.com:8000/"),
   "proxy-user", "proxy-password"]

如果指定了代理选项,则该值应该是包含3个元素的数组。它应该包含一个代理URI,一个代理用户名和一个代理密码。代理URI应该是一个字符串,一个URI或零。代理用户名和密码应该是一个字符串。

如果为代理URI提供nil,则仅忽略此选项。

如果指定了proxy和proxy_http_basic_authentication,则会引发ArgumentError。

:http_basic_authentication

概要:

:http_basic_authentication=>[user, password]

如果指定了http_basic_authentication,则该值应该是包含2个字符串的数组:用户名和密码。它用于RFC 2617定义的HTTP基本认证。

:content_length_proc

概要:

:content_length_proc => lambda {|content_length| ... }

如果:指定了content_length_proc选项,则在实际传输开始之前调用选项值过程。它需要一个参数,这是预期的内容长度(以字节为单位)。

如果通过HTTP重定向执行两次或多次传输,则仅在最后一次传输中调用该过程一次。

如果预期的内容长度未知,则使用nil调用该过程。这发生在HTTP响应没有Content-Length标头时。

:progress_proc

概要:

:progress_proc => lambda {|size| ...}

如果指定了progress_proc选项,则每次open' gets content fragment from network. The argumentsize是累计传输大小(以字节为单位)时,都会使用一个参数调用proc 。

如果通过HTTP重定向完成两次或多次传输,则仅对最后一次传输调用该过程。

:progress_proc和:content_length_proc旨在用于进度条。例如,它可以使用Ruby / ProgressBar按如下方式实现。

pbar = nil
open("http://...",
  :content_length_proc => lambda {|t|
    if t && 0 < t
      pbar = ProgressBar.new("...", t)
      pbar.file_transfer_mode
    end
  },
  :progress_proc => lambda {|s|
    pbar.set s if pbar
  }) {|f| ... }

:read_timeout

概要:

:read_timeout=>nil     (no timeout)
:read_timeout=>10      (10 second)

:read_timeout选项指定http连接的读取超时。

:open_timeout

概要:

:open_timeout=>nil     (no timeout)
:open_timeout=>10      (10 second)

:open_timeout选项指定为http连接打开的超时时间。

:ssl_ca_cert

概要:

:ssl_ca_cert=>filename or an Array of filenames

:ssl_ca_cert用于为SSL指定CA证书。如果给出,则不使用默认证书。

:ssl_verify_mode

概要:

:ssl_verify_mode=>mode

:ssl_verify_mode用于指定openssl验证模式。

:ftp_active_mode

概要:

:ftp_active_mode=>bool

:ftp_active_mode => true用于制作ftp主动模式。Ruby 1.9默认使用被动模式。请注意,活动模式在Ruby 1.8或之前版本中是默认的。

:redirect

概要:

:redirect=>bool

:redirect默认情况下为true。:redirect => false用于禁用所有HTTP重定向。

重定向时引发OpenURI :: HTTPRedirect异常。true也意味着使用http和ftp之间的重定向是允许的。

# File lib/open-uri.rb, line 719
def open(*rest, &block)
  OpenURI.open_uri(self, *rest, &block)
end

read(options={}) Show source

#read)读取self引用的内容并以字符串形式返回内容。该字符串使用OpenURI :: Meta进行扩展。参数options与#open相同。

# File lib/open-uri.rb, line 727
def read(options={})
  self.open(options) {|f|
    str = f.read
    Meta.init str, f
    str
  }
end
Ruby 2.4

Ruby 是一种面向对象、命令式、函数式、动态的通用编程语言,是世界上最优美而巧妙的语言。

主页 https://www.ruby-lang.org/
源码 https://github.com/ruby/ruby
版本 2.4
发布版本 2.4.1

Ruby 2.4目录

1.缩略 | Abbrev
2.ARGF
3.数组 | Array
4.Base64
5.基本对象 | BasicObject
6.基准测试 | Benchmark
7.BigDecimal
8.绑定 | Binding
9.CGI
10.类 | Class
11.比较 | Comparable
12.负责 | Complex
13.计算续体 | Continuation
14.覆盖 | Coverage
15.CSV
16.日期 | Date
17.日期时间 | DateTime
18.DBM
19.代理 | Delegator
20.摘要 | Digest
21.Dir
22.DRb
23.编码 | Encoding
24.枚举 | Enumerable
25.枚举 | Enumerator
26.ENV
27.ERB
28.错误 | Errors
29.Etc
30.期望值 | Exception
31.错误类 | FalseClass
32.Fiber
33.Fiddle
34.文件 | File
35.文件实用程序 | FileUtils
36.查找 | Find
37.浮点 | Float
38.Forwardable
39.GC
40.GDBM
41.GetoptLong
42.Hash
43.Integer
44.IO
45.IPAddr
46.JSON
47.Kernel
48.语言 | 3Language
49.记录 | Logger
50.编排 | Marshal
51.MatchData
52.数学 | Math
53.矩阵 | Matrix
54.方法 | Method
55.模型 | Module
56.监控 | Monitor
57. 互斥 | Mutex
58.Net
59.Net::FTP
60.Net::HTTP
61.Net::IMAP
62.Net::SMTP
63.NilClass
64.数字 | Numeric
65.对象 | Object
66.ObjectSpace
67.Observable
68.Open3
69.OpenSSL
70.OpenStruct
71.OpenURI
72.OptionParser
73.路径名 | Pathname
74.完整输出 | PrettyPrint
75.Prime
76.Proc
77.过程 | Process
78.PStore
79.PTY
80.队列 | Queue
81.随机 | Random
82.范围 | Range
83.合理的 | Rational
84.Readline
85.Regexp
86.Resolv
87.Ripper
88.RubyVM
89.Scanf
90.SDBM
91.SecureRandom
92.Set
93.Shell
94.信号 | Signal
95.Singleton
96.套接字 | Socket
97.字符串 | String
98.StringIO
99.StringScanner
100.结构 | Struct