Automatic generation produced by ISE Eiffel
note description: "[ cURL easy externals. For more informaton see: http://curl.haxx.se/libcurl/c/ ]" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2019-10-17 04:58:44 -0800 (Thu, 17 Oct 2019) $" revision: "$Revision: 103601 $" deferred class interface CURL_EASY_EXTERNALS_I feature -- Access generating_type: TYPE [detachable CURL_EASY_EXTERNALS_I] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: CURL_EASY_EXTERNALS_I): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: CURL_EASY_EXTERNALS_I): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: CURL_EASY_EXTERNALS_I): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void is_api_available: BOOLEAN -- Is cURL API available? same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Duplication copy (other: CURL_EASY_EXTERNALS_I) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: CURL_EASY_EXTERNALS_I) -- Effect equivalent to that of: -- `copy` (other . `deep_twin`) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: CURL_EASY_EXTERNALS_I -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: CURL_EASY_EXTERNALS_I) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: CURL_EASY_EXTERNALS_I -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: CURL_EASY_EXTERNALS_I -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable CURL_EASY_EXTERNALS_I -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.`default` for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Command cleanup (a_curl_handle: POINTER) -- Declared as curl_easy_cleanup. require exists: not a_curl_handle.is_default_pointer init: POINTER -- Declared as curl_easy_init(). require is_api_available: is_api_available ensure exists: not Result.is_default_pointer perform (a_curl_handle: POINTER): INTEGER_32 -- Declared as curl_easy_perform. -- Result is one value from {CURL_CODES} require exists: not a_curl_handle.is_default_pointer setopt_curl_string (a_curl_handle: POINTER; a_opt: INTEGER_32; a_curl_string: CURL_STRING) -- Declared as curl_easy_setopt. require exists: not a_curl_handle.is_default_pointer valid: (create {CURL_OPT_CONSTANTS} end).is_valid (a_opt) not_void: a_curl_string /= Void setopt_file (a_curl_handle: POINTER; a_opt: INTEGER_32; a_file: FILE) -- Declared as curl_easy_setopt. require exists: not a_curl_handle.is_default_pointer valid: a_opt = {CURL_OPT_CONSTANTS}.curlopt_readdata or a_opt = {CURL_OPT_CONSTANTS}.curlopt_headerdata readable: a_file /= Void and then a_file.file_readable setopt_form (a_curl_handle: POINTER; a_opt: INTEGER_32; a_form: CURL_FORM) -- Declared as curl_easy_setopt. require exists: not a_curl_handle.is_default_pointer valid: (create {CURL_OPT_CONSTANTS} end).is_valid (a_opt) not_void: a_form /= Void and then a_form.is_exists setopt_integer (a_curl_handle: POINTER; a_opt: INTEGER_32; a_integer: INTEGER_32) -- Declared as curl_easy_setopt. require exists: not a_curl_handle.is_default_pointer valid: (create {CURL_OPT_CONSTANTS} end).is_valid (a_opt) setopt_mime (a_curl_handle: POINTER; a_opt: INTEGER_32; a_mime: POINTER) -- Declared as curl_easy_setopt. require exists: not a_curl_handle.is_default_pointer valid: a_opt = {CURL_OPT_CONSTANTS}.curlopt_mimepost exists: a_mime /= default_pointer setopt_slist (a_curl_handle: POINTER; a_opt: INTEGER_32; a_curl_slist: POINTER) -- Declared as curl_easy_setopt. require exists: not a_curl_handle.is_default_pointer valid: a_opt = {CURL_OPT_CONSTANTS}.curlopt_httpheader or else a_opt = {CURL_OPT_CONSTANTS}.curlopt_mail_rcpt exists: a_curl_slist /= default_pointer setopt_string (a_curl_handle: POINTER; a_opt: INTEGER_32; a_string: READABLE_STRING_GENERAL) -- Declared as curl_easy_setopt. require exists: not a_curl_handle.is_default_pointer valid: (create {CURL_OPT_CONSTANTS} end).is_valid (a_opt) not_void: a_string /= Void feature -- Function pointer curl_easy_cleanup_ptr: POINTER curl_easy_getinfo_ptr: POINTER curl_easy_init_ptr: POINTER curl_easy_perform_ptr: POINTER curl_easy_setopt_ptr: POINTER feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void feature -- Query getinfo (a_curl_handle: POINTER; a_info: INTEGER_32; a_data: CELL [detachable ANY]): INTEGER_32 -- `curl_getinfo require exists: not a_curl_handle.is_default_pointer valid: (create {CURL_INFO_CONSTANTS} end).is_valid (a_info) feature -- Special setting curl_function: CURL_FUNCTION -- cURL functions in curl_easy_setopt. ensure not_void: Result /= Void set_curl_function (a_curl_function: CURL_FUNCTION) -- Set `curl_function` with a_curl_function ensure set: a_curl_function /= Void implies curl_function = a_curl_function set_debug_function (a_curl_handle: POINTER) -- Set cURL debug function require exists: not a_curl_handle.is_default_pointer set_progress_function (a_curl_handle: POINTER) -- Set cURL progress function for upload/download progress. require exists: not a_curl_handle.is_default_pointer set_read_function (a_curl_handle: POINTER) -- Set cURL read function -- Set cURL read function with Eiffel default read function. -- So we can use a c file pointer as parameter in {CURL_EASY_EXTERNALS}.setopt_file_pointer when the option is {CURL_OPT_CONSTANTS}.curlopt_readdata require exists: not a_curl_handle.is_default_pointer set_write_function (a_curl_handle: POINTER) -- Set cURL write function -- Set cURL write function with Eiffel default write function. -- So we can use CURL_STRING as parameter in {CURL_EASY_EXTERNALS}.setopt_curl_string when the option is {CURL_OPT_CONSTANTS}.curlopt_writedata require exists: not a_curl_handle.is_default_pointer invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note library: "cURL: Library of reusable components for Eiffel." copyright: "Copyright (c) 1984-2019, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class CURL_EASY_EXTERNALS_I -- Generated by Eiffel Studio --
For more details: eiffel.org