htslib.knetfile source code

1 /* The MIT License
2 
3    Copyright (c) 2008, 2012, 2014, 2021 Genome Research Ltd (GRL).
4                  2010 by Attractive Chaos <attractor@live.co.uk>
5 
6    Permission is hereby granted, free of charge, to any person obtaining
7    a copy of this software and associated documentation files (the
8    "Software"), to deal in the Software without restriction, including
9    without limitation the rights to use, copy, modify, merge, publish,
10    distribute, sublicense, and/or sell copies of the Software, and to
11    permit persons to whom the Software is furnished to do so, subject to
12    the following conditions:
13 
14    The above copyright notice and this permission notice shall be
15    included in all copies or substantial portions of the Software.
16 
17    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
21    BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
22    ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24    SOFTWARE.
25 */
26 module htslib.knetfile;
27 
28 import core.sys.posix.fcntl;
29 import core.sys.posix.sys.types;
30 
31 @system:
32 nothrow:
33 @nogc:
34 
35 extern (C):
36 
37 // alias netread = read;
38 // alias netwrite = write;
39 // alias netclose = close;
40 
41 // FIXME: currently I/O is unbuffered
42 
43 enum KNF_TYPE_LOCAL = 1;
44 enum KNF_TYPE_FTP = 2;
45 enum KNF_TYPE_HTTP = 3;
46 
47 // Kept for API/ABI compatability only.  Do not use directly!
48 struct knetFile_s
49 {
50     int type;
51     int fd;
52     long offset;
53     char* host;
54     char* port;
55 
56     // the following are for FTP only
57     int ctrl_fd;
58     int[4] pasv_ip;
59     int pasv_port;
60     int max_response;
61     int no_reconnect;
62     int is_ready;
63     char* response;
64     char* retr;
65     char* size_cmd;
66     long seek_offset; // for lazy seek
67     long file_size;
68 
69     // the following are for HTTP only
70     char* path;
71     char* http_host;
72 }
73 
74 alias knetFile = knetFile_s;
75 
76 extern (D) auto knet_tell(T)(auto ref T fp)
77 {
78     return fp.offset;
79 }
80 
81 extern (D) auto knet_fileno(T)(auto ref T fp)
82 {
83     return fp.fd;
84 }
85 
86 knetFile* knet_open(const(char)* fn, const(char)* mode);
87 
88 /*
89    This only works with local files.
90  */
91 knetFile* knet_dopen(int fd, const(char)* mode);
92 
93 /*
94   If ->is_ready==0, this routine updates ->fd; otherwise, it simply
95   reads from ->fd.
96  */
97 ssize_t knet_read(knetFile* fp, void* buf, size_t len);
98 
99 /*
100   This routine only sets ->offset and ->is_ready=0. It does not
101   communicate with the FTP server.
102  */
103 off_t knet_seek(knetFile* fp, off_t off, int whence);
104 int knet_close(knetFile* fp);
105